概要
is_object_in_taxonomy関数は、特定のオブジェクトが指定されたタクソノミーに属しているかどうかを検査するための関数です。この関数は、カスタム投稿タイプやタクソノミーの利用を考慮したテーマやプラグインの開発時に、以下のような機能を実装する際によく使われます。
- 投稿が特定のカテゴリに含まれているかどうかのチェック
- カスタムタクソノミーを使用したフィルタリング機能
- サイドバーウィジェットでの条件付き表示
- カスタムクエリを利用する際の条件設定
- テンプレートファイルでのコンテンツ表示制御
- 特定の条件に基づいたメタボックスの表示制御
- REST APIエンドポイントのカスタマイズ
- 関連投稿の表示条件の設定
構文
is_object_in_taxonomy( $object_id, $taxonomy );
パラメータ
$object_id(int|string) – タクソノミーに関連付けられているオブジェクトのID。$taxonomy(string|array) – チェックするタクソノミーのスラッグまたはスラッグの配列。
戻り値
- (bool) – オブジェクトがタクソノミーに属している場合は
true、そうでない場合はfalseを返します。
関連する関数
使用可能なバージョン
- WordPress 2.5.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 |
非推奨または削除されたバージョン
- 現在のところ、この関数は非推奨または削除されていません。