esc_url

説明

string esc_url( string $url [ , array $protocols = null [ , string $_context = 'display' ] ] )
URL文字列を調べ、余分な文字を取り除いたり、変換したりする。

パラメータ

  • $url
    URL文字列
  • $protocols
    有効なプロトコルを示す配列を指定(省略時はnull
  • $_context
    プライベート:コンテキストタイプを指定(省略時は'display')

返り値

きれいになったURL文字列を返す。

注意

パラメータ$protocolsの省略時は、次の配列が適用される。
array ('http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn')
パラメータ$_contextはプライベートなものなので、原則的には指定しない(省略時の'display'で使用する)。この場合、URL文字列に含まれる'&'は'&'に、"'"は'''に変換される。

使用例

  • $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

最終更新 : 2019年05月10日 09:47



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。