概要
wp_add_object_terms関数は、投稿情報などにタクソノミーを追加するために使用されるWordPressの関数です。特定のオブジェクト（主に投稿やカスタム投稿タイプ）に対して、指定されたタクソノミーの用語を追加します。この関数は、タクソノミーを使用した分類やフィルタリング機能を実装する際によく利用されます。その典型的な用途は以下の通りです。
- 投稿にタグを付与する
- カスタム投稿タイプにカテゴリを付与する
- 複数の用語を一度に追加する
- 検索機能を向上させるためのメタ情報の追加
- 管理画面での表示をカスタマイズする
- データの分類を提供してフィルタオプションを実現する
- タクソノミーを使用したコンテンツのグルーピング
- SEO対策としてのキーワード管理
構文
wp_add_object_terms( $object_id, $terms, $taxonomy, $append = false );
パラメータ
$object_id(int): 投稿やカスタム投稿タイプのID。$terms(string|array): 追加するタクソノミーの用語名。$taxonomy(string): 使用するタクソノミーのスラッグ。$append(bool): 既存の用語に追加する場合はtrue、置き換えたい場合はfalseを指定する（デフォルトはfalse）。
戻り値
- 成功した場合は追加された用語の配列、失敗した場合はWP_Errorオブジェクト。
関連する関数
使用可能なバージョン
wp_add_object_terms関数はWordPress 3.0.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 |
この関数は特定のワードプレスバージョンで非推奨または削除されてはいません。