WEB制作のための情報サイト / unazuki Library

esc_attr()

基本構文と使い方(引数・実行結果)

基本構文

属性値をエスケープし、安全な文字列として出力します。
具体的には、HTMLの中で使われる<>のような特殊文字を文字参照に変換します。例えば<は&lt;に>は&gt;に変換します。文字参照に変換することで、<>のようなHTMLにとって特別な意味を持つタグを単なる文字列として扱うことができます。これにより、呼び出すデータに危険な <script> などが仕込まれていてもscriptを実行しないため安全です。

esc_attr($text);

似たものにesc_html()がありますが、esc_html()はタグの中身、esc_attr()は属性の値に対して使います。

引数

引数必須/任意引数に指定するもの
第1引数
$text
必須エスケープする属性(文字列)

実行結果

戻り値(返す値):エスケープされた属性を返します。
※表示するにはechoします。

学習者向け補足情報

【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。

【引数について】

  • 指定できる引数の数はテンプレートタグによって異なります。(引数なしもあり)
  • 引数ごとに必須 / 任意が決まっています。(必須は必ず指定、任意は指定しなければ初期値)
  • 引数名(例:$post)は仕様の便宜上の名前と考えてください。(この名前自体はテンプレートタグ実行に関係しません。各引数に何を指定するのかを理解していればOKです。)

参考コード

属性の値を外部やデータベースから動的に取得して埋め込む場合などに使うことができます。

<?php
$value = '例えばカスタムフィールドから取得した値';
$alt = '例えばカスタムフィールドから取得した値';
?>
<input type="text" value="<?php echo esc_attr($value); ?>">
<img src="<?php echo esc_url(get_theme_file_uri('/img/example.jpg')); ?>" alt="<?php echo esc_attr($alt); ?>">

※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。

関連するテンプレートタグ

テンプレートタグ 説明
antispambot() エンティティ化したメールアドレスを返します。
esc_html() HTMLをエスケープし、安全な文字列として出力します。
esc_url() URLをエスケープし、安全な文字列として出力します。