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
    ターム(投稿タグなど)の文字列を指定(省略時は'')。複数指定する場合はカンマ(,)で区切るか、その配列を指定する。カテゴリーなどの階層タイプのタクソノミーの場合はタームIDまたはその配列を指定する。
  • $taxonomy
    タクソノミータイプを指定(省略時は'post_tag')。
  • $append
    投稿タグを追加する場合はtrue、設定する場合はfalseを指定(省略時はfalse)。

返り値

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

注意

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

使用例

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

フィルター

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

アクション

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

ソースファイル

/wp-includes/post.php

最終更新 : 2023年08月18日 13:18



お勧め

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。