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



お勧め

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

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

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

5.3の新機能:JPEG画像の向きを自動調整(2019年10月17日 更新)

WordPress 5.3 Beta 1」に記載されていた「Automatic image rotation during upload」という見出し。画像ファイルに含まれるEXIF情報内の「向き」により、画像の向きを自動的に調整するというもの。どんな実装なのか気になったのでソースコードをざっくり眺めてみた。

投稿画面のウェジェットを2列にする(2013年4月17日 更新)

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。