当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

関数リファレンス/esc url

提供: WordPress Codex 日本語版
< 関数リファレンス
2013年8月11日 (日) 18:36時点におけるDjkaz (トーク | 投稿記録)による版 (英語版をコピペ。)

(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
移動先: 案内検索

Always use esc_url when sanitizing URLs (in text nodes, attribute nodes or anywhere else). Rejects URLs that do not have one of the provided whitelisted protocols (defaulting to http, https, ftp, ftps, mailto, news, irc, gopher, nntp, feed, and telnet), eliminates invalid characters, and removes dangerous characters. This function encodes characters as HTML entities: use it when generating an (X)HTML or XML document. Encodes ampersands (&) and single quotes (') as numeric entity references (&#038, &#039).

Replaces the deprecated clean_url().

使用法

%%%<?php esc_url( $url, $protocols, $_context ); ?>%%%

パラメータ

$url
string) (必須) The URL to be cleaned.
初期値: なし
$protocols
array) (optional) An array of acceptable protocols. Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet' if not set.
初期値: null
$_context
string) (optional) How the URL will be used. Default is 'display'.
初期値: 'display'

戻り値

(string) 
The cleaned $url after the 'clean_url' filter is applied. An empty string is returned if $url specifies a protocol other than those in $protocols, or if $url contains an empty string.

使用例

As featured in the Twenty Thirteen theme, although simplified for the sake of the example

<a href="<?php echo esc_url( home_url( '/' ) ); ?>">Home</a>

注釈

改訂履歴

  • 2.8 にて導入されました。

ソースファイル

esc_url()wp-includes/formatting.php にあります。

See the Data Validation article for an in-depth discussion of input and output sanitization.


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp get nav menu items最新版との差分