概要
wp_set_post_tags 関数は、指定した投稿に対して投稿タグを設定するための関数です。この関数は、投稿情報に投稿タグを設定する際によく使われます。例えば、以下のような用途で使われることがあります。
- 新規投稿作成時に自動的にタグを追加する。
- 投稿が更新された際にタグを変更する。
- カスタム投稿タイプに対してタグを設定する。
- インポート作業時にタグを一括設定する。
- プラグインやテーマで動的にタグを設定する。
- 投稿の分類を整理するためにメタデータとしてタグを利用する。
- タグの一括削除や編集を行う。
- オートメーションツールでタグ管理を行う。
構文
wp_set_post_tags( $post_id, $tags, $append );
パラメータ
$post_id(int): タグを設定する投稿の ID。$tags(string|array): 設定するタグの名前または名前の配列。$append(bool):trueの場合、既存のタグに追加し、falseの場合は既存のタグを置き換えます。
戻り値
- 成功時は新たに設定したタグの配列、失敗した場合は
false。
関連する関数
使用可能なバージョン
wp_set_post_tags 関数は、WordPress のバージョン 2.3.0 以降で使用可能です。
コアファイルのパス
wp-includes/taxonomy.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
この関数は、特定のWordPressバージョンで非推奨又は削除されたという情報はありません。