Help us understand the problem. What is going on with this article?

WordPress の esc_html_e() と esc_html() が紛らわしかったのでメモ

More than 3 years have passed since last update.

海外製のテーマによく出てくる esc_html_e()

WordPressで海外製のテーマをいじっていると esc_html_e() という関数がいっぱい出てくる。

esc_html ということはHTMLの何かしらのエスケープだろうし、_e ということは何かしらの翻訳なんだろうけど…と思いつつほったらかしていたので、改めて Codex をチェック。

Function Reference/esc html e « WordPress Codex

うん、まあそのままか。

esc_html_e($text, $domain);

のように、引数にエスケープしたいテキストとドメイン名(翻訳ファイルのありかを指す…らしい)を指定すればよいとのこと。

日本人なら esc_html() やろが!

…いや日本人に限らず、ですが。通常のクライアントワークではテーマファイルを多言語化することなどまず無いので、esc_html() で十分ですよね。

esc_html($text);

引数にテキストを指定するだけ。わかりやすい。

esc_html() と esc_html_e() の決定的な違い

というわけで、テーマファイル内の esc_html_e()esc_html() に書き換えていたところ、「あれ?テキストが表示されない…」という事態に。

それもそのはず、 esc_html_e() は関数内に echo を含んでいるので「記述するだけでテキストを出力する」のですが、 esc_html() はただ値を取って来るだけなので、 echo で出力してあげねばなりません。

■ esc_html_e() を用いた出力
<?php esc_html_e('Pen-pineapple-apple-pen', 'picotaro'); ?>

■ esc_html() を用いた出力
<?php echo esc_html('Pen-pineapple-apple-pen'); ?>

こういうことですね。

あとがき

どっちかにあわせてちょうよ。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした