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

最終更新 : 2014年07月04日 11:39



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

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

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