• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/sanitize term field

提供: WordPress Codex 日本語版
移動先: 案内検索

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

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

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

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

使い方

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

パラメータ

$field
文字列) (必須) 無害化するタームのフィールド名
初期値: なし
$value
文字列) (必須) タームのフィールドの値
初期値: なし
$term_id
整数) (必須) ターム ID
初期値: なし
$taxonomy
文字列) (必須) タクソノミー名
初期値: なし
$context
文字列) (必須) どのようにタームのフィールドを無害化するか。
初期値: なし
有効な値は:
  • 'raw' - 数値フィールドの値のみ無害化
参考:数値フィールドは parent, term_id, count, term_group, term_taxonomy_id, および object_id です。
  • 'edit' - 各種フィルターフックで無害化
  • 'db' - 各種フィルターフックで無害化
  • 'rss' - 各種フィルターフックで無害化
  • 'display' - 各種フィルターフックで無害化
  • 'attribute' - 各種フィルターフックの後、esc_attr() で無害化
  • 'js' - 各種フィルターフックの後、esc_js() で無害化

戻り値

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

参考

apply_filters() を使って下記のフィルターを呼び出します。

  1. $context'edit' である場合のみ:
    • 'edit_term_{$field}' - 引数は $value, $term_id および $taxonomy
    • 'edit_{$taxonomy}_{$field}' - 引数は $value$term_id
  2. $context'db' である場合のみ:
    • 'pre_term_{$field}' - 引数は $value$taxonomy
    • 'pre_{$taxonomy}_{$field}' - 引数は $value
  3. $context'rss である場合のみ:
    • 'term_{$field}_rss - 引数は $value$taxonomy
    • '{$taxonomy}_{$field}_rss' - 引数は $value
  4. $context'raw', 'edit', 'db', 'rss' の何れでもない場合:
    • 'term_{$field}' - 引数は $value, $term_id, $taxonomy および $context
    • '{$taxonomy}_{$field}' - 引数は $value, $term_id および $context

改訂履歴

2.3.0 にて導入されました。

ソースファイル

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


サニタイズ関数: sanitize_email(), sanitize_file_name(), sanitize_html_class(), sanitize_key(), sanitize_meta(), sanitize_mime_type(), sanitize_option(), sanitize_sql_orderby(), sanitize_post_field(), sanitize_text_field(), sanitize_title(), sanitize_title_for_query(), sanitize_title_with_dashes(), sanitize_user()


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