ワードプレスのget_object_taxonomies関数の使用方法・解説

概要

get_object_taxonomies関数は、特定の投稿タイプに関連するタクソノミー(カテゴリーやタグなど)の情報を取得するための関数です。この関数は通常、カスタム投稿タイプやカテゴライズのニーズがある場合に使用されます。主に以下のようなシナリオで利用されます。

  1. カスタム投稿タイプに関連付けられたタクソノミーを取得する。
  2. 特定のタクソノミーに基づいて投稿をフィルタリングする。
  3. 自作の管理パネルやウィジェットでタクソノミーを表示する。
  4. テーマやプラグインでタクソノミーを動的に追加・管理する。
  5. タクソノミーのメタデータを取得して表示する。
  6. REST APIを通じてタクソノミー情報を提供する。
  7. カスタムクエリにおいてタクソノミーを使用する。
  8. タクソノミーを用いたセクション分けやナビゲーションを構築する。

構文

get_object_taxonomies( string|object $object, string $args = 'names' )

パラメータ

  • $object: 投稿タイプ名、WP_Postオブジェクト、またはタクソノミーを取得するオブジェクト。
  • $args: 取得する情報の形式。デフォルトは names (タクソノミーの名前)。

戻り値

指定した投稿タイプに関連するタクソノミーのリスト(文字列または配列)。

関連する関数

バージョン情報

この関数はWordPress 2.3.0以降で利用可能です。

コアファイルパス

wp-includes/taxonomy.php

サンプルコード

以下に、get_object_taxonomies関数の使用例を5つ示します。

サンプルコード 1

// 投稿タイプ 'book' に関連するタクソノミーを取得
$taxonomies = get_object_taxonomies( 'book' );
print_r( $taxonomies );

このサンプルでは、カスタム投稿タイプ「book」に関連するタクソノミーの名前を取得して表示しています。

サンプルコード 2

// 投稿オブジェクトからタクソノミーを取得
$post = get_post(1); // 投稿ID 1を取得
$taxonomies = get_object_taxonomies( $post );
print_r( $taxonomies );

このサンプルでは、特定の投稿(ID:1)から関連するタクソノミーを取得し、表示しています。

サンプルコード 3

// タクソノミーの情報を詳細に取得
$taxonomies = get_object_taxonomies( 'event', 'objects' );
foreach($taxonomies as $taxonomy) {
    echo $taxonomy->label . '<br>';
}

このサンプルは、投稿タイプ「event」に関連するタクソノミーのラベルを詳細に表示しています。

サンプルコード 4

// すべての存在するタクソノミーを取得
$taxonomies = get_object_taxonomies( null );
print_r( $taxonomies );

このサンプルでは、全投稿タイプに関連するすべてのタクソノミーを取得して表示します。

サンプルコード 5

// 特定の引数でタクソノミーを取得
$taxonomies = get_object_taxonomies( 'post', 'names' );
echo implode(', ', $taxonomies);

このサンプルでは、デフォルトの投稿タイプ「post」に関連するタクソノミーの名前をカンマで区切って表示しています。

この関数のアクションでの使用可能性

アクション名 使用可能性
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

この表では、get_object_taxonomies関数が使用されるアクションを示しており、特定のアクションでの使用可能性を確認できます。

この関数について質問する


上の計算式の答えを入力してください