説明
string esc_url( string $url [ , array $protocols = null [ , string $_context = 'display' ] ] )
URL文字列を調べ、余分な文字を取り除いたり、変換したりする。
パラメータ
- $urlURL文字列
- $protocols有効なプロトコルを示す配列を指定（省略時はnull）
- $_contextプライベート：コンテキストタイプを指定（省略時は'display'）
返り値
きれいになったURL文字列を返す。注意
パラメータ$protocolsの省略時は、次の配列が適用される。
array ('http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn')
パラメータ$_contextはプライベートなものなので、原則的には指定しない（省略時の'display'で使用する）。この場合、URL文字列に含まれる'&'は'&'に、"'"は'''に変換される。
[6.9.0]パラメータ$urlにスキームが含まれない場合、従来は'http://'を必ず追加していたが、$protocolsの内容に応じて'https://'または'http://'を追加するように変更された。
使用例
- $urlのURL文字列を調べ、クリーニングする。
<?php $new_url = esc_url( $url ); ?>
フィルター
[2.3.0]安全なURLを返す前に'clean_url'フィルターを呼び出す。パラメータ$good_protocol_urlには安全なURLが、$original_urlには本関数が受け取った$urlの内容が、$_contextには本関数が受け取った内容が格納されている。return apply_filters( 'clean_url', $good_protocol_url, $original_url, $_context );アクション
実行するアクションはありません。ソースファイル
/wp-includes/formatting.php最終更新 : 2025年12月04日 16:13
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群（2018年5月27日 更新）
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。