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

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

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

提供: WordPress Codex 日本語版
< 関数リファレンス
2015年5月27日 (水) 21:31時点におけるMiccweb (トーク | 投稿記録)による版 (新規追加、未訳あり)

(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
移動先: 案内検索

説明

Adds a new term to the database. Optionally marks it as an alias of an existing term.

データベースに新しいタームを追加します。必要に応じて既存のタームのエイリアスとしてマークします。

使い方

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

パラメータ

$term
int|文字列) (必須) タームを追加または更新する
初期値: なし
$taxonomy
文字列) (必須) タームを追加するためのタクソノミー
初期値: なし
$args
array|文字列) (optional) タームを挿入された値を変更する
初期値: なし

引数

The arguments decide how the term is handled based on the $args parameter. The following is a list of the available overrides and the defaults.

'alias_of'
string) (optional) There is no default, but if added, expected is the slug that the term will be an alias of.
初期値: なし
'description'
string) (optional) If exists, will be added to the database along with the term.
初期値: なし
'parent'
numeric) (optional) Will assign value of 'parent' to the term.
初期値: 0 (zero)
'slug'
string) (optional
初期値: なし

If 'slug' argument exists then the slug will be checked to see if it is not a valid term. If that check succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check succeeds, the term will be inserted and the term id will be given. If the slug argument is empty, then it will be calculated from the term name.

戻り値

(array|WP_Error) 
タームIDとタームタクソノミーIDが戻る。 (例: array('term_id'=>12,'term_taxonomy_id'=>34))

Error handling is assigned for the nonexistence of the $taxonomy and $term parameters before inserting. If both the term id and taxonomy exist previously, then an array will be returned that contains the term id and the contents of what is returned. The keys of the array are 'term_id' and 'term_taxonomy_id' containing numeric values.

It is assumed that the term does not yet exist or the above will apply. The term will be first added to the term table and then related to the taxonomy if everything is well. If everything is correct, then several actions will be run prior to a filter and then several actions will be run after the filter is run.

用例

$parent_term = term_exists( 'fruits', 'product' ); // array is returned if taxonomy is given
$parent_term_id = $parent_term['term_id']; // get numeric term id
wp_insert_term(
  'Apple', // the term 
  'product', // the taxonomy
  array(
    'description'=> 'A yummy apple.',
    'slug' => 'apple',
    'parent'=> $parent_term_id
  )
);

フックの使い方

  • 'pre_insert_term' filter with $term and $taxonomy as parameters

This function calls these hooks with term id and taxonomy id as parameters:

  • 'create_term' action
  • 'create_$taxonomy' action
  • 'term_id_filter' filter
  • 'created_term' action
  • 'created_$taxonomy' action

更新履歴

新規導入: 2.3.0

ソースファイル

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

関連

wp_update_term, wp_unique_term_slug

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


このページ「関数リファレンス/wp insert term」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

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