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

「関数リファレンス/sanitize term field」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(最初の和訳。)
((訳語の修正)クレンジング ⇒ 無害化)
3行目: 3行目:
 
</div>
 
</div>
  
タームのフィールドの値を、コンテキストに基づいてクレンジングします。
+
タームのフィールドの値を、コンテキストに基づいて無害化(サニタイズ、クレンジング)します。
  
この関数に渡したタームのフィールドの値を渡すと、そのフィールドが使われる予定のコンテキストに応じてクレンジングされます。
+
この関数に渡したタームのフィールドの値を渡すと、そのフィールドが使われる予定のコンテキストに応じて無害化されます。
 
<!-- Passing a term field value through the function should be assumed to have cleansed the value for whatever context the term field is going to be used. -->
 
<!-- Passing a term field value through the function should be assumed to have cleansed the value for whatever context the term field is going to be used. -->
  
23行目: 23行目:
 
</div>
 
</div>
  
{{Parameter|$field|文字列|クレンジングするタームのフィールド|必須}}
+
{{Parameter|$field|文字列|無害化するタームのフィールド|必須}}
 
{{Parameter|$value|文字列|このターム値を探す|必須}}
 
{{Parameter|$value|文字列|このターム値を探す|必須}}
 
{{Parameter|$term_id|整数|ターム ID|必須}}
 
{{Parameter|$term_id|整数|ターム ID|必須}}
33行目: 33行目:
 
</div>
 
</div>
  
{{Return||mixed|クレンジングされたフィールド}}
+
{{Return||mixed|無害化されたフィールド}}
  
 
<div id="Change Log">
 
<div id="Change Log">

2014年8月10日 (日) 11:48時点における版

タームのフィールドの値を、コンテキストに基づいて無害化(サニタイズ、クレンジング)します。

この関数に渡したタームのフィールドの値を渡すと、そのフィールドが使われる予定のコンテキストに応じて無害化されます。

空のコンテキストまたは未サポートのコンテキストを与えると、デフォルトのフィルターが適用されます。

独自のフィルター関数を作らなくても、コンテキスト毎にカスタムフィルタリングをサポートする充分なフィルターがあります。 必要なフィルターをフックする関数を作るだけで済みます。

使い方

<?php sanitize_term_field( $field, $value, $term_id, $taxonomy, $context ); ?>

パラメータ

$field
文字列) (必須) 無害化するタームのフィールド
初期値: なし
$value
文字列) (必須) このターム値を探す
初期値: なし
$term_id
整数) (必須) ターム ID
初期値: なし
$taxonomy
文字列) (必須) タクソノミー名
初期値: なし
$context
文字列) (必須) edit, db, display, attribute, または js の何れか。
初期値: なし

戻り値

(mixed) 
無害化されたフィールド

改訂履歴

2.3.0 にて導入されました。

ソースファイル

sanitize_term_field()wp-includes/taxonomy.php にあります。

最新英語版: WordPress Codex » Function Reference/sanitize_term_field最新版との差分