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



お勧め

Login rebuilder:プラグイン作ってみました(2024年11月7日 更新)

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 更新)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

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

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。

ブロックエディターで現在の「ロケール」を取得した時のメモ(2024年8月10日 更新)

ブロックエディター向けのプラグインで日本語固有の機能を実装する際、現在のロケール(言語)を取得したい。ブロックエディターの編集時、投稿を編集しているユーザーの言語が優先され、それをどうやって取得するかを「ChatGPT」に聞いてみたのだが。。。