wp_set_object_terms:WordPress私的マニュアル

wp_set_object_terms

(2.3.0以降)
wp_set_object_terms - 投稿情報などにタクソノミーを設定する

説明

mixed wp_set_object_terms( int $object_id, mixed $terms, mixed $taxonomy [ , bool $append = false ] )

投稿情報などにタクソノミーを設定する。

パラメータ

$object_id
投稿情報などのIDを指定
$terms
タームID、ターム名またはそれらの配列を指定
$taxonomy
'category'や'post_tag'などのタクソノミー名またはその配列を指定
$append
追加のみを行う場合はtrue、指定したタクソノミー以外を削除する場合はfalseを指定（省略時、false）

返り値

正しく設定できた場合はタームIDの配列を返す。設定できなかった場合は、エラー内容を示すWP_Errorオブジェクトを返す。

注意

カスタム投稿タイプにカテゴリを設定する場合は、register_post_type関数による登録際、'taxonomies'プロパティに'category'を指定しておくこと。この指定がない場合は正しく動作しない。
wp_set_post_categories関数ではカテゴリーをIDまたはその配列で指定するが、このwp_set_object_terms関数は文字列で指定できるので、こちらのほうが便利かも。

使用例

投稿IDが10の投稿情報に'ニュース'と'値下げ'のカテゴリーを設定する。
<?php wp_set_object_terms( 10, array( 'ニュース', '値下げ' ), 'category' ); ?>

フィルター

実行するフィルターはありません。

アクション

タクソノミーの関連付け情報を追加する前に'add_term_relationship'アクションを呼び出す。

do_action( 'add_term_relationship', $object_id, $tt_id );

タクソノミーの関連付け情報を追加した後に'added_term_relationship'アクションを呼び出す。

do_action( 'added_term_relationship', $object_id, $tt_id );

タクソノミーの関連付け情報を削除する前に'delete_term_relationship'アクションを呼び出す。

do_action( 'delete_term_relationships', $object_id, $delete_terms );

タクソノミーの関連付け情報を削除した後に'deleted_term_relationship'アクションを呼び出す。

do_action( 'deleted_term_relationships', $object_id, $delete_terms );

返り値を返す直前に'set_object_terms'アクションを呼び出す。

do_action( 'set_object_terms', $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids );

ソースファイル

/wp-includes/taxonomy.php

参考

Code Reference: wp_set_object_terms

参考

wp_insert_postでカスタム投稿追加時に、カスタム分類を設定する方法 - cocowa