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

「関数リファレンス/esc url」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(英語版をコピペ。)
 
(和訳完了。)
2行目: 2行目:
 
== 説明 ==
 
== 説明 ==
 
</div>
 
</div>
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.
+
テキストや属性などのURLを無害化する時に用いる関数です。ホワイトリストに登録されているプロトコル (デフォルトでは、http, https, ftp, ftps, mailto, news, irc, gopher, nntp, feed, telnet) 以外のURLを拒絶し、無効なキャラクタを除外し、危険なキャラクタを削除します。
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).
+
この関数はキャラクタをHTMLエンティティとしてエンコードし、 (X)HTML または XML ドキュメントを作成する時に用います。アンド記号 <tt>(&)</tt> とシングルクォート <tt>(')</tt> はそれぞれ <tt>(&#038, &#039)</tt> という形に変換します。
 
+
この関数は非推奨となった <tt>clean_url()</tt> の代わりに用いるものです。
Replaces the deprecated clean_url().
+
  
 
<div id="Usage">
 
<div id="Usage">
 
== 使用法 ==
 
== 使用法 ==
 
</div>
 
</div>
%%%<?php esc_url( $url, $protocols, $_context ); ?>%%%
+
<?php esc_url( $url, $protocols, $_context ); ?>
  
 
<div id="Parameters">
 
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 
</div>
 
</div>
{{Parameter|$url|string|The URL to be cleaned.}}
+
{{Parameter|$url|string|無害化しようとするURL}}
{{Parameter|$protocols|array|An array of acceptable protocols. Defaults to '<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>' if not set.|optional|null}}
+
{{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|How the URL will be used. Default is '<tt>display</tt>'.|optional|'display'}}
+
{{Parameter|$_context|string|URLをどのように用いるか。デフォルトは '<tt>display</tt>'.|optional|'display'}}
  
 
<div id="Return Values">
 
<div id="Return Values">
 
== 戻り値 ==
 
== 戻り値 ==
 
</div>
 
</div>
; (string) : The cleaned <tt>$url</tt> after the '<tt>clean_url</tt>' filter is applied.  An empty string is returned if <tt>$url</tt> specifies a protocol other than those in <tt>$protocols</tt>, or if <tt>$url</tt> contains an empty 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>
As featured in the '''Twenty Thirteen''' theme, although simplified for the sake of the example
+
'''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()]]
See the [[Data Validation]] article for an in-depth discussion of input and output sanitization.
+
入力と出力の無害化について詳しくは、[[Data Validation|データ検証]] 記事を参照してください。
  
 
{{Tag Footer}}
 
{{Tag Footer}}
  
  
{{原文|Function Reference/wp get nav menu items|134358}}<!-- 15:08, 10 August 2013 Djkaz 版 -->
+
{{原文|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 ドキュメントを作成する時に用います。アンド記号 (&) とシングルクォート (') はそれぞれ (&#038, &#039) という形に変換します。 この関数は非推奨となった 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最新版との差分