ワードプレスのesc_attr_e関数の使用方法・解説

概要

esc_attr_e関数は、特定の文字列をエスケープし、その文字列を国際化（i18n）対応で表示するために使用されます。この関数は、主にHTMLの属性内で表示するために出力されるテキストに対して使用されます。以下は、esc_attr_e関数がよく使われる場面の例です。

1. テキストフィールドの値を表示する
2. ボタンのラベルを表示する
3. HTMLのリンクのタイトル属性を表示する
4. メタデータの属性値を表示する
5. カスタムウィジェットの設定を表示する
6. テーマのオプションページでの表示
7. プラグインの設定ページでの表示
8. AJAXレスポンスデータ内の属性値を表示する

構文

esc_attr_e( $text, $domain );

パラメータ

• $text (string) – 表示したい文字列。
• $domain (string) – 翻訳ドメイン。省略可能で、デフォルトはテーマのテキストドメイン。

戻り値

この関数は、翻訳テキストを直接出力し、その後、HTML属性用にエスケープされた結果を返します。戻り値はありません。

関連する関数

• esc_attr
• __
• _e

使用可能なバージョン

esc_attr_eは、WordPressのバージョン1.2以降で利用できます。

コアファイルのパス

この関数は、wp-includes/l10n.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	〇

esc_attr_e関数は、特定のWordPressバージョンで非推奨または削除されていません。