esc_html_e() の使い方|説明・引数・注意点

説明

esc_html_e() は、文字列を翻訳し、HTMLエスケープして出力する関数です。

基本構文

esc_html_e( string $text, string $domain = 'default' ): void

引数

  • $text:翻訳元の文字列
  • $domain:テキストドメイン

戻り値

戻り値はありません(出力します)。

使い方(サンプル)

esc_html_e( 'Read more', 'my-theme' );

注意点

  • echo esc_html__() と同じ結果です。

実務での使いどころ

  • 固定の文字列を、翻訳して、HTMLのテキストとして、安全に出力するとき。

よくあるミスと対処

  • HTMLを含む翻訳に使っている。タグが、エスケープされる。
  • テキストドメインを、変数にしている。翻訳の抽出ができないため、文字列で、直接書く。
  • 属性値に、使っている。属性値には、esc_attr_e() を使う。

NG例

esc_html_e( '<strong>重要</strong>', 'my-plugin' ); // タグが、文字として表示される

OK例

echo wp_kses_post( __( '<strong>重要</strong>', 'my-plugin' ) );

使い分け早見表

関数 特徴
esc_html_e() 翻訳して、エスケープして出力する
_e() 翻訳して、出力する(エスケープなし)
esc_attr_e() 翻訳して、属性値用にエスケープして出力する

関連項目

esc_html__()、_e()

公式リファレンス:esc_html_e() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました