esc_html__

説明

string esc_html__( string $text [ , string $domain = 'default' )
エスケープ処理した翻訳テキストを取得する。

パラメータ

  • $text
    翻訳するテキストを指定。
  • $domain
    ドメイン名を指定(省略時は'default')。

返り値

パラメータ$textについて現在のロケールに応じた翻訳テキストをエスケープ処理して返す。翻訳テキストが見つからなかった場合は$textをエスケープ処理して返す。


注意

__ esc_html関数の合わせ技で、すぐに表示する場合はesc_html_e関数が使える。また似たような関数として esc_attr__もある。

翻訳テキストにはhtmlタグが含まれる場合があり、当然のことながらこの関数の返り値はそれらもエスケープ処理を行う。


使用例

  • エスケープ処理した翻訳テキストを取得して表示する。
    <?php echo '<p>' . esc_html__( 'As follows', 'DOMAIN' ) . '</p>'; ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/l10n.php

最終更新 : 2018年11月07日 10:25



お勧め

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

管理画面でよく使うスタイルをまとめてみた「メッセージ編」(2019年7月30日 更新)

標準で用意されているスタイルを知っておくことで、独自に用意するスタイルを軽減でき、機能拡張した部分の見た目は違和感が少なくなる。そんな共通要素のスタイルのひとつが「メッセージ」だ。メッセージにはいくつかの意味合いがあり、用途に応じてすぐに使い分けすることになる。今回はそんなメッセージ向けのスタイルをざっくりまとめてみた。