概要
wp_add_post_tags 関数は、WordPress の投稿にタグを追加するための便利な関数です。この関数は特に以下のようなシナリオでよく使用されます。
- 投稿作成時に自動的にタグを設定したい場合
- カスタム投稿タイプにタグを追加したい場合
- バッチ処理で大量の投稿にタグを追加したい場合
- ユーザーインターフェースから投稿の一括編集を行う際にタグを自動で追加したい場合
- プラグイン開発時に投稿に対してタグを操作したい場合
- 投稿内容に基づいて関連タグを自動生成したい場合
- 投稿の表示や検索結果のフィルタリングを改善するためのタグ追加
- SEO対策として特定のキーワードをタグとして設定したい場合
構文
wp_add_post_tags( $post_id, $tags, $append = false );
パラメータ
$post_id(int) – タグを追加する投稿の ID。$tags(string|array) – 追加するタグの名前。カンマ区切りの文字列または配列として指定可能。$append(bool) –trueの場合、既存のタグに追加、falseの場合は既存のタグを置き換える。デフォルトはfalse。
戻り値
- 成功した場合は
true、失敗した場合はfalseを返します。
関連する関数
使用可能なバージョン
wp_add_post_tagsは、WordPress バージョン 3.3 以降で使用可能です。
コアファイルのパス
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 |
wp_add_post_tags 関数は、特定のバージョンで非推奨または削除されていません。