説明
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
関連
お勧め
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。
テーマから投稿画像のサイズを指定する(2012年3月15日 更新)
投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。ログインページを変える(2014年9月12日 更新)
WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)
ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。