wp_set_post_tags()


WordPressのwp_set_post_tags()関数は、指定された投稿にタグを設定するために使用されます。この関数は、既存のタグを置き換えるか、新しいタグを追加するために利用できます。

構文

wp_set_post_tags( int $post_id, string|array $tags = '', bool $append = false );

引数の説明:

  • $post_id(int) — タグを設定する投稿のID。
  • $tags(string|array) — 投稿に設定するタグ。カンマ区切りの文字列または配列で指定できます。
  • $append(bool) — 既存のタグに追加する場合はtrue、タグを置き換える場合はfalse。

例1: 投稿にタグを追加する

この例では、投稿IDを取得し、新しいタグを追加します。

wp_set_post_tags(get_the_ID(), '新規タグ', true);

例2: 投稿のタグを置き換える

この例では、投稿のタグを新しいタグに置き換えます。

wp_set_post_tags(get_the_ID(), 'タグ1, タグ2', false);

例3: 配列を使用してタグを設定する

タグを配列として指定することもできます。

wp_set_post_tags(get_the_ID(), array('タグA', 'タグB'), true);

例4: カスタム投稿タイプにタグを追加する

カスタム投稿タイプにもタグを追加できます。

wp_set_post_tags(123, 'カスタムタグ', true);

例5: タグを削除する

空のタグを指定すると、すべてのタグが削除されます。

wp_set_post_tags(get_the_ID(), '', false);

例6: 複数のタグを一度に追加する

複数のタグをカンマ区切りで追加します。

wp_set_post_tags(get_the_ID(), 'タグ1, タグ2, タグ3', true);

例7: タグを追加せずに置き換える

既存のタグを新しいタグに置き換えます。

wp_set_post_tags(get_the_ID(), '新しいタグ', false);

例8: タグを追加する前に投稿IDを確認する

投稿IDが存在するか確認してからタグを追加します。

if(get_the_ID()) { wp_set_post_tags(get_the_ID(), '確認タグ', true); }

注意点

  • タグを追加する際に、既存のタグを上書きしないように$appendパラメータをtrueに設定してください。
  • タグ名にカンマが含まれる場合は、配列を使用することを推奨します。
  • 投稿IDが無効な場合、関数は何も実行しません。

関連機能：