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



お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

もうquery_postsは呼ばない(2011年9月27日 更新)

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭で query_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。