- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）
「関数リファレンス/esc url」の版間の差分
提供: WordPress Codex 日本語版
< 関数リファレンス
(英語版をコピペ。) |
(和訳完了。) |
||
| 2行目: | 2行目: | ||
== 説明 == | == 説明 == | ||
</div> | </div> | ||
| − | + | テキストや属性などのURLを無害化する時に用いる関数です。ホワイトリストに登録されているプロトコル (デフォルトでは、http, https, ftp, ftps, mailto, news, irc, gopher, nntp, feed, telnet) 以外のURLを拒絶し、無効なキャラクタを除外し、危険なキャラクタを削除します。 | |
| − | + | この関数はキャラクタをHTMLエンティティとしてエンコードし、 (X)HTML または XML ドキュメントを作成する時に用います。アンド記号 <tt>(&)</tt> とシングルクォート <tt>(')</tt> はそれぞれ <tt>(&, ')</tt> という形に変換します。 | |
| − | + | この関数は非推奨となった <tt>clean_url()</tt> の代わりに用いるものです。 | |
| − | + | ||
<div id="Usage"> | <div id="Usage"> | ||
== 使用法 == | == 使用法 == | ||
</div> | </div> | ||
| − | + | <?php esc_url( $url, $protocols, $_context ); ?> | |
<div id="Parameters"> | <div id="Parameters"> | ||
== パラメータ == | == パラメータ == | ||
</div> | </div> | ||
| − | {{Parameter|$url|string| | + | {{Parameter|$url|string|無害化しようとするURL}} |
| − | {{Parameter|$protocols|array| | + | {{Parameter|$protocols|array|受け入れ可能なプロトコルの配列。デフォルトは、'<tt>http</tt>', '<tt>https</tt>', '<tt>ftp</tt>', '<tt>ftps</tt>', '<tt>mailto</tt>', '<tt>news</tt>', '<tt>irc</tt>', '<tt>gopher</tt>', '<tt>nntp</tt>', '<tt>feed</tt>', '<tt>telnet</tt>'|optional|null}} |
| − | {{Parameter|$_context|string| | + | {{Parameter|$_context|string|URLをどのように用いるか。デフォルトは '<tt>display</tt>'.|optional|'display'}} |
<div id="Return Values"> | <div id="Return Values"> | ||
== 戻り値 == | == 戻り値 == | ||
</div> | </div> | ||
| − | ; (string) : | + | ; (string) : '<tt>clean_url</tt>' フィルターと通して無害化された <tt>$url</tt>が返されます。もし <tt>$protocols</tt> に指定されていないプロトコルを <tt>$url</tt> が用いていた場合、あるいはそもそも <tt>$url</tt> が空であった場合は、空の配列が返されます。 |
<div id="Examples"> | <div id="Examples"> | ||
| 30行目: | 29行目: | ||
=== ホームへのリンクを追加する === | === ホームへのリンクを追加する === | ||
</div> | </div> | ||
| − | + | '''Twenty Thirteen''' テーマでの用例を示します。これはサンプルとして単純化したものです。 | |
<pre><a href="<?php echo esc_url( home_url( '/' ) ); ?>">Home</a></pre> | <pre><a href="<?php echo esc_url( home_url( '/' ) ); ?>">Home</a></pre> | ||
| 58行目: | 57行目: | ||
** [[Function Reference/urlencode|urlencode()]] | ** [[Function Reference/urlencode|urlencode()]] | ||
** [[Function Reference/urlencode_deep|urlencode_deep()]] | ** [[Function Reference/urlencode_deep|urlencode_deep()]] | ||
| − | + | 入力と出力の無害化について詳しくは、[[Data Validation|データ検証]] 記事を参照してください。 | |
{{Tag Footer}} | {{Tag Footer}} | ||
| − | {{原文|Function Reference/ | + | {{原文|Function Reference/esc url|134408}}<!-- 09:09, 11 August 2013 Djkaz 版 --> |
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:New_page_created]] | [[Category:New_page_created]] | ||
2013年8月11日 (日) 19:48時点における版
テキストや属性などのURLを無害化する時に用いる関数です。ホワイトリストに登録されているプロトコル (デフォルトでは、http, https, ftp, ftps, mailto, news, irc, gopher, nntp, feed, telnet) 以外のURLを拒絶し、無効なキャラクタを除外し、危険なキャラクタを削除します。 この関数はキャラクタをHTMLエンティティとしてエンコードし、 (X)HTML または XML ドキュメントを作成する時に用います。アンド記号 (&) とシングルクォート (') はそれぞれ (&, ') という形に変換します。 この関数は非推奨となった clean_url() の代わりに用いるものです。
使用法
<?php esc_url( $url, $protocols, $_context ); ?>
パラメータ
- $url
- （string） （必須） 無害化しようとするURL
- 初期値： なし
- $protocols
- （array） （optional） 受け入れ可能なプロトコルの配列。デフォルトは、'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet'
- 初期値： null
- $_context
- （string） （optional） URLをどのように用いるか。デフォルトは 'display'.
- 初期値： 'display'
戻り値
- (string)
- 'clean_url' フィルターと通して無害化された $urlが返されます。もし $protocols に指定されていないプロトコルを $url が用いていた場合、あるいはそもそも $url が空であった場合は、空の配列が返されます。
使用例
ホームへのリンクを追加する
Twenty Thirteen テーマでの用例を示します。これはサンプルとして単純化したものです。
<a href="<?php echo esc_url( home_url( '/' ) ); ?>">Home</a>
注釈
改訂履歴
- 2.8 にて導入されました。
ソースファイル
esc_url() は wp-includes/formatting.php にあります。
関連項目
入力と出力の無害化について詳しくは、データ検証 記事を参照してください。
関数リファレンス、テンプレートタグ目次もご覧ください。
最新英語版： WordPress Codex » Function Reference/esc url （最新版との差分）
