wp_set_post_terms

(2.8.0以降)
wp_set_post_terms - 投稿情報に投稿タグを設定する

説明

mixed wp_set_post_terms( [ int $post_id = 0 [ , mixed $tags = '' [ , string $taxonomy = 'post_tag' [ , bool $append = false ] ] ] ] )
投稿情報に投稿タグを設定する。

パラメータ

  • $post_id
    投稿情報のIDを指定（省略時は0）。
  • $tags
    投稿タグ（ターム）の文字列を指定（省略時は''）。複数指定する場合はカンマ（,）で区切るか、その配列を指定する。
  • $taxonomy
    タクソノミータイプを指定（省略時は'post_tag'）。
  • $append
    投稿タグを追加する場合はtrue、設定する場合はfalseを指定（省略時はfalse）。

返り値

投稿タグを更新した場合は、それらのタームIDの配列を返す。更新できなかった場合はfalseまたはWP_Errorのオブジェクトを返す。

注意

パラメータ$taxonomyに'post_tag'以外を指定することで、任意のカスタムタクソノミーに対応できると思われる。
パラメータ$tagsに複数のタクソノミーを追加する場合はカンマ（,）などで囲む。内部では$tagsをカンマ区切りで分割するが、分割を行う前段階として前後の空白文字とカンマは除外している。

使用例

  • IDが10の投稿情報に投稿タグ'Ultrabook'と'値下げ'を設定する。
    <?php wp_set_post_tags( 10, 'Ultrabook,値下げ' ); ?>
  • IDが10の投稿情報に投稿タグ'Ultrabook'を追加する。
    <?php wp_set_post_tags( 10, 'Ultrabook', 'post_tag', true ); ?>

フィルター

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

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/post.php

関連

参考

Code Reference: wp_set_post_terms

お勧めコンテンツ

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

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

プラグインのヘッダー情報を国際化対応しよう（2017年6月19日 登録）

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

canvasタグを投稿したい（2013年12月27日 登録）

以前「投稿内容のid属性などを保存するための対策」で取り上げたように、WordPressでは投稿に記述できるHTMLタグが制限されている。同コラムでこの制限を調整する対策を紹介しているが、3.5以降ではフィルター関数を登録して対応できるようだ。

メディア（attachment）を拡張してより便利に活用する（2014年5月22日 登録）

「メディア（attachment）」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。

4.4では投稿ページも専用テンプレートが適用できる（2015年11月7日 登録）

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

最終更新日時 : 2014-07-04 11:39