当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

関数リファレンス/esc url

提供: WordPress Codex 日本語版
< 関数リファレンス
2013年8月11日 (日) 19:48時点におけるDjkaz (トーク | 投稿記録)による版 (和訳完了。)

移動先: 案内検索

テキストや属性などのURLを無害化する時に用いる関数です。ホワイトリストに登録されているプロトコル (デフォルトでは、http, https, ftp, ftps, mailto, news, irc, gopher, nntp, feed, telnet) 以外のURLを拒絶し、無効なキャラクタを除外し、危険なキャラクタを削除します。 この関数はキャラクタをHTMLエンティティとしてエンコードし、 (X)HTML または XML ドキュメントを作成する時に用います。アンド記号 (&) とシングルクォート (') はそれぞれ (&#038, &#039) という形に変換します。 この関数は非推奨となった clean_url() の代わりに用いるものです。

使用法

<?php esc_url( $url, $protocols, $_context ); ?>

パラメータ

$url
string) (必須) 無害化しようとするURL
初期値: なし
$protocols
array) (optional) 受け入れ可能なプロトコルの配列。デフォルトは、'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet'
初期値: null
$_context
string) (optional) URLをどのように用いるか。デフォルトは 'display'.
初期値: 'display'

戻り値

(string) 
'clean_url' フィルターと通して無害化された $urlが返されます。もし $protocols に指定されていないプロトコルを $url が用いていた場合、あるいはそもそも $url が空であった場合は、空の配列が返されます。

使用例

Twenty Thirteen テーマでの用例を示します。これはサンプルとして単純化したものです。

<a href="<?php echo esc_url( home_url( '/' ) ); ?>">Home</a>

注釈

改訂履歴

  • 2.8 にて導入されました。

ソースファイル

esc_url()wp-includes/formatting.php にあります。

入力と出力の無害化について詳しくは、データ検証 記事を参照してください。


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/esc url最新版との差分