当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/wp set object terms」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(関連項目)
80行目: 80行目:
  
 
[[en:Function Reference/wp_set_object_terms]]
 
[[en:Function Reference/wp_set_object_terms]]
 +
[[it:Riferimento_funzioni/wp_set_object_terms]]

2014年7月21日 (月) 23:29時点における版

このページ「関数リファレンス/wp set object terms」は情報が古くなっている可能性があります。最新版英語)も合わせてご覧ください。翻訳にご協力くださる方はぜひご相談ください

投稿やリンクなどのオブジェクトを term とタクソノミータイプ (タグ、カテゴリー等) に関連付ける関数です。存在しない場合は、term とタクソノミーの関連付けを作成します。

関連付けとは、term がタクソノミーのグループに属することを意味します。Term はどのタクソノミー配下にいるかを定義するコンテキストが与えられるまでは意味を持ちません。

使用法

<?php wp_set_object_terms( $object_id, $terms, $taxonomy, $append ) ?>

パラメータ

$object_id
int) (必須) 投稿 ID など、関連づけられるオブジェクト
初期値: なし
$terms
array / int / string) (必須) カテゴリーやタグ ID などのTerm のスラッグまたは ID。これはタクソノミー内全ての関連する term を置き換えます。オブジェクトから全ての term をクリアまたは削除するためには、空の文字列または NULL を渡します。整数の場合はタグ ID として解釈されます。
初期値: なし
$taxonomy
array / string) (必須) オブジェクトに関連づけられる term のコンテキスト。これは、カテゴリー、投稿タグ、他のタクソノミー名が入ります。
初期値: なし
$append
bool) (required) True の場合、タグがオブジェクトに付加されます。False の場合、既存のタグが置き換えられます。
初期値: False

戻り値

(mixed) 
  • (array) 成功した場合、 変更される term の配列が返されます。
  • (WP_Error) 無効なタクソノミー ('invalid_taxonomy') には WordPress Error オブジェクトが返されます。
  • (string) $term パラメーターで渡された term が誤って名付けられていた場合、最初の無効な term。(無効な term ID は受け入れられ、挿入されます)。

使用例

ID 42 の投稿にカテゴリーを追加したい場合。

<?php
$cat_ids = array( 6,8 );
    //terms IDが整数である旨確認する:
    //$cat_ids = array_map('intval', $cat_ids);
    //$cat_ids = array_unique( $cat_ids );
wp_set_object_terms( '42', $cat_ids, 'category' );
?>

ID 42 の投稿からすべてのカテゴリーをクリア / 削除する場合。

<?php wp_set_object_terms( '42', NULL, 'category' ); ?>

改訂履歴

  • 3.5.0 にてデータベース挿入に失敗した時、 WP_Error オブジェクトを返すように改訂されました。
  • 2.3.0 にて導入されました。

注釈

おそらくwp_set_post_terms() の方がより使いやすい関数といえるでしょう。それは値をチェックし、コンマで区切られたタクソノミーを変換し、階層化された整数のtermを検証するからです。

ソースファイル

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

タームタグ: is_term(), term_exists(), get_objects_in_term(), get_term(), get_term_by(), get_term_children(), get_term_link(), get_terms(), get_the_terms(), get_the_term_list(), has_term(), sanitize_term(), the_terms(), get_object_taxonomies() is_object_in_taxonomy() the_taxonomies() wp_get_object_terms(), wp_set_object_terms(), wp_get_post_terms(), wp_set_post_terms(), wp_delete_object_term_relationships()



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


最新英語版: WordPress Codex » Function Reference/wp set object terms最新版との差分