概要
get_taxonomy 関数は、WordPressのタクソノミーに関する情報を取得するための関数です。この関数を使用することで、特定のタクソノミーのプロパティを簡単に取得することができます。例えば、カスタムタクソノミーを作成した場合や、カテゴリやタグの詳細を表示したい場合に便利です。
よく使われるシナリオは以下の通りです:
- カスタムタクソノミーの情報を取得し、表示する。
- 特定のタクソノミーのスラッグを取得する。
- タクソノミーに関連するメタ情報を表示する。
- 投稿のタクソノミー設定をカスタマイズする。
- タクソノミータームのリンクを生成する。
- タクソノミーのラベルをカスタマイズする。
- 特定のタクソノミーを持つ投稿のクエリを行う。
- タクソノミーの階層情報を表示する。
構文
get_taxonomy( $taxonomy );
パラメータ
- $taxonomy (string) – タクソノミーのスラッグ(例えば、’category’やカスタムタクソノミーの名前)。
戻り値
- (object|false) – 指定したタクソノミーのオブジェクト情報。存在しない場合は false を返します。
関連する関数
使用可能なバージョン
- WordPress 2.8 以降で使用可能。
コアファイルのパス
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 |
サンプルコード
-
タクソノミー情報の取得
$taxonomy = get_taxonomy( 'category' ); echo '<pre>'; print_r( $taxonomy ); echo '</pre>';- カテゴリータクソノミーの詳細情報を取得し、表示します。
-
カスタムタクソノミーのチェック
if ( get_taxonomy( 'my_custom_tax' ) ) { echo 'カスタムタクソノミーが存在します。'; } else { echo 'カスタムタクソノミーが存在しません。'; }- カスタムタクソノミーの存在を確認します。
-
タクソノミーのスラッグを取得
$taxonomy = get_taxonomy( 'post_tag' ); echo 'スラッグ: ' . $taxonomy->rewrite['slug'];- タグタクソノミーのスラッグを表示します。
-
タクソノミーのラベル情報を取得
$taxonomy = get_taxonomy( 'post_category' ); echo 'タクソノミーラベル: ' . $taxonomy->label;- カテゴリータクソノミーのラベルを表示します。
-
タクソノミーのサポートするオブジェクトタイプの取得
$taxonomy = get_taxonomy( 'category' ); echo 'サポートオブジェクト: '; print_r( $taxonomy->object_type );- カテゴリータクソノミーがサポートするオブジェクトタイプを表示します。
これらのサンプルコードは、WordPressの公式ドキュメントやフォーラム、GitHubリポジトリからの著作権フリーの情報を基に作成されています。