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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/sanitize_term_field 17:55, 17 July 2011 Rarst 版を流し込み。)
 
(最初の和訳。)
1行目: 1行目:
{{NeedTrans}}
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
== Description ==
+
タームのフィールドの値を、コンテキストに基づいてクレンジングします。
  
Cleanse the field value in the term based on the context.
+
この関数に渡したタームのフィールドの値を渡すと、そのフィールドが使われる予定のコンテキストに応じてクレンジングされます。
 +
<!-- 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.
+
空のコンテキストまたは未サポートのコンテキストを与えると、デフォルトのフィルターが適用されます。
  
If no context or an unsupported context is given, then default filters will be applied.
+
独自のフィルター関数を作らなくても、コンテキスト毎にカスタムフィルタリングをサポートする充分なフィルターがあります。
 +
必要なフィルターをフックする関数を作るだけで済みます。
  
There are enough filters for each context to support a custom filtering without creating your own filter function. Simply create a function that hooks into the filter you need.
+
<div id="Usage">
 
+
== 使い方 ==
== Usage ==
+
</div>
  
 
  <?php sanitize_term_field( $field, $value, $term_id, $taxonomy, $context ); ?>
 
  <?php sanitize_term_field( $field, $value, $term_id, $taxonomy, $context ); ?>
  
== Parameters ==
+
<div id="Parameters">
 
+
== パラメータ ==
{{Parameter|$field|string|Term field to sanitize|required}}
+
</div>
 
+
{{Parameter|$value|string|Search for this term value|required}}
+
 
+
{{Parameter|$term_id|int|Term ID|required}}
+
 
+
{{Parameter|$taxonomy|string|Taxonomy Name|required}}
+
  
{{Parameter|$context|string|Either edit, db, display, attribute, or js.|required}}
+
{{Parameter|$field|文字列|クレンジングするタームのフィールド|必須}}
 +
{{Parameter|$value|文字列|このターム値を探す|必須}}
 +
{{Parameter|$term_id|整数|ターム ID|必須}}
 +
{{Parameter|$taxonomy|文字列|タクソノミー名|必須}}
 +
{{Parameter|$context|文字列|edit, db, display, attribute, または js の何れか。|必須}}
  
== Return Values ==
+
<div id="Return Values">
 +
== 戻り値 ==
 +
</div>
  
{{Return||mixed|sanitized field}}
+
{{Return||mixed|クレンジングされたフィールド}}
  
== Change Log ==
+
<div id="Change Log">
 +
== 改訂履歴 ==
 +
</div>
  
Since: [[Version 2.3|2.3]]
+
[[Version 2.3|2.3.0]] にて導入されました。
  
== Source File ==
+
<div id="Source File">
 +
== ソースファイル ==
 +
</div>
  
<tt>sanitize_term_field()</tt> is located in {{Trac|wp-includes/taxonomy.php}}
+
<tt>sanitize_term_field()</tt> {{Trac|wp-includes/taxonomy.php}} にあります。
  
 
{{原文|Function Reference/sanitize_term_field|107582}} <!-- 17:55, 17 July 2011 Rarst 版 -->
 
{{原文|Function Reference/sanitize_term_field|107582}} <!-- 17:55, 17 July 2011 Rarst 版 -->

2014年8月2日 (土) 12:09時点における版

タームのフィールドの値を、コンテキストに基づいてクレンジングします。

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

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

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

使い方

<?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最新版との差分