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

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

関数リファレンス/wp insert term

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

この項目「関数リファレンス/wp insert term」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

新しいタームをデータベースへ追加します。オプションで、既存のタームのエイリアスである印をつけます。

使い方

<?php wp_insert_term( $term, $taxonomy, $args = array() ); ?>

パラメータ

$term
整数|文字列) (必須) 追加または更新するタームの名前。
初期値: なし
$taxonomy
文字列) (必須) タームを追加するタクソノミー。
初期値: なし
$args
配列|文字列) (オプション) この引数に従って、追加するタームの値を変更する。
初期値: なし

引数

この関数は $args パラメータに基づいて、タームの処理方法を変更します。次のリストは変更できる内容とデフォルトです。

'alias_of'
文字列) (オプション) デフォルトはありませんが、指定された場合、このスラッグを持つ別のタームのエイリアスとしてタームを追加します。
初期値: なし
'description'
文字列) (オプション) 指定された場合、タームと一緒にデータベースへ追加されます。
初期値: なし
'parent'
整数) (オプション) タームの親('parent' の値)を指定します。
初期値: 0 – ゼロ(親なし)
'slug'
文字列) (オプション
初期値: なし

'slug' 引数を指定すると、それが有効なタームではないことをチェックします。成功した場合(有効なタームではない)、そのまま追加されてターム ID が与えられます。失敗した場合、タクソノミーが階層を持ち parent 引数が空でないことがチェックされます。この 2 番目のチェックが成功すると、タームが追加されてターム ID が与えられます。slug 引数が空ならタームの名前から自動生成されます。.

戻り値

(配列|WP_Error) 
ターム ID と ターム・タクソノミー ID の 2 要素の配列。(例: array( 'term_id' => 12, 'term_taxonomy_id' => 34 )

エラー処理は、タームを追加する前、$taxonomy$term パラメータが存在しない場合に行われます。ターム ID とタクソノミーが両方とも存在していた場合、返される配列はターム ID と既存のデータになります。その配列のキーは 'term_id' と 'term_taxonomy_id' で、値は数値です。

タームがまだ存在しないか、それとも上記のように処理するかを想定しています。まずタームを term テーブルへ追加し、問題なければそれをタクソノミーに関連づけます。すべて正しく行われると、いくつかのアクション、フィルターがひとつ、さらにいくつかのアクションの順に実行されます。(使われるフックを見てください。)

用例

$parent_term = term_exists( 'fruits', 'product' ); // タクソノミーが存在すれば配列が返される
$parent_term_id = $parent_term['term_id']; // ターム ID(数値)を取得
wp_insert_term(
  'Apple', // ターム名
  'product', // タクソノミー
  array(
    'description'=> 'A yummy apple.',
    'slug' => 'apple',
    'parent'=> $parent_term_id
  )
);

使われるフック

  • 'pre_insert_term' – パラメータとして $term$taxonomy をフィルターします。

この関数は、ターム IDターム・タクソノミー ID をパラメータとして次のフックを呼び出します:

  • 'create_term' – アクション($taxonomy が第 3 パラメータに入ります)
  • 'create_$taxonomy' – アクション
  • 'term_id_filter' – フィルター
  • 'created_term' – アクション($taxonomy が第 3 パラメータに入ります)
  • 'created_$taxonomy' – アクション

変更履歴

2.3.0 : 新規導入

ソースファイル

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

wp_update_term, wp_unique_term_slug

関数リファレンステンプレートタグ目次もご覧ください。


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