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



お勧め

5.3の新機能:サイト管理者のメールアドレスを定期的に確認する(2019年9月27日 更新)

WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。

各投稿記事で設定されているカスタムフィールドの値を取得するには(2011年9月16日 更新)

投稿記事ごとに設定されているカスタムフィールドの値は get_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。

ツイート引用が簡単になる仕組み(2012年6月8日 更新)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。