概要
esc_html__ 関数は、エスケープ処理した翻訳テキストを取得するために使用されます。この関数は、ユーザーが入力したデータやプラグインからの出力を成形する際に非常に便利です。この関数は、HTMLコンテンツを表示する際に安全性を確保するために、出力されるテキストを適切にエスケープします。以下は、esc_html__ 関数がよく使われるシナリオです。
- プラグイン設定ページのテキスト出力
- カスタム投稿タイプのタイトル表示
- テーマのテンプレートでのユーザーのコメント表示
- メッセージやエラーメッセージの表示
- アーカイブページのタイトル生成
- ワードプレス管理画面でのフィールドラベル
- ウィジェットの表示テキスト
- サイトのヘッダーやフッターに表示される情報
構文
esc_html__( string $text, string $domain = 'default' )
パラメータ
$text: 翻訳対象のテキスト。$domain: テキストドメイン（デフォルトは ‘default’ ）。
戻り値
エスケープ処理された翻訳テキストを返します。
関連する関数
使用可能なバージョン
esc_html__ 関数は、WordPress 4.0.0 以降で使用可能です。
コアファイルのパス
wp-includes/functions.php
この関数のアクションでの使用可能性
| アクション | 使用可否 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | 〇 |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | 〇 |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | 〇 |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | 〇 |
| wp_head | 〇 |
この関数は特定のバージョンで非推奨または削除されていません。