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

関連

お勧めコンテンツ

スクリプトファイルのバージョンパラメータを変更する(2015年2月10日 登録)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

カスタムフィールド関連関数のおさらい(2012年6月22日 登録)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 登録)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

Somewhere search box:プラグイン作ってみました(2012年12月24日 登録)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

WordCamp Tokyo 2013(2013年9月14日 登録)

本日開催された「WordCamp Tokyo 2013」に行ってきました。昨年と同様、会場は大田区産業プラザで、PHPカンファレンスと共催でしたね。

最終更新日時 : 2013-08-08 15:33