概要
taxonomy_exists
関数は、特定のタクソノミーが存在するかを調べるために使用されます。この関数は、カスタムタクソノミーやデフォルトのタクソノミー(例:カテゴリーやタグ)が登録されているかどうかを確認する際に便利です。この関数がよく使われる場面は以下の通りです:
- カスタムポストタイプに関連するタクソノミーが存在するかチェックする
- プラグインでタクソノミーを使用する際に、そのタクソノミーが登録されているか確認する
- テーマの設定で、特定のタクソノミーが必要な場合に存在を検証する
- 複数のタクソノミーを持つサイトで、特定のタクソノミーの存在を確認する
- カスタムフィールドやメタデータを利用する際に、タクソノミーの存在を確認する
- タクソノミーに基づくクエリを実行する前のチェック
- プラグインでのエラーハンドリングのための条件分岐
- 管理画面での表示内容を条件によって変える際のチェック
構文
taxonomy_exists($taxonomy);
パラメータ
$taxonomy
(string): 確認したいタクソノミーのスラッグ。
戻り値
- タクソノミーが存在する場合は
true
、存在しない場合はfalse
を返します。
関連する関数
使用可能なバージョン
- WordPress 2.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 |
サンプルコード
サンプルコード1:タクソノミーの存在確認
$taxonomy = 'category';
if (taxonomy_exists($taxonomy)) {
echo "タクソノミー '$taxonomy' は存在します。";
} else {
echo "タクソノミー '$taxonomy' は存在しません。";
}
// このコードは、特定のタクソノミー(カテゴリー)が存在するかどうかを確認するサンプルです。
URL: なし
サンプルコード2:カスタムタクソノミーのチェック
$custom_taxonomy = 'custom_tax';
if (taxonomy_exists($custom_taxonomy)) {
// カスタムタクソノミーが存在する場合の処理
} else {
// エラーメッセージや代替処理
}
// このコードは、カスタムタクソノミーの存在をチェックし、存在しない場合に処理を分けるサンプルです。
URL: なし
サンプルコード3:タクソノミーによる条件分岐
if (taxonomy_exists('post_tag')) {
echo "タグタクソノミーは存在します。";
// 更なる処理...
}
// このコードは、デフォルトのタグタクソノミーが存在するかをチェックし、条件に基づいて処理を行うサンプルです。
URL: なし
サンプルコード4:タクソノミーが存在しない場合のエラーメッセージ
$taxonomy = 'non_existing_taxonomy';
if (!taxonomy_exists($taxonomy)) {
echo "エラー: タクソノミー '$taxonomy' は存在しません。";
}
// このコードは、指定したタクソノミーが存在しない場合にエラーメッセージを表示するサンプルです。
URL: なし
サンプルコード5:タクソノミーのカスタムクエリ
$taxonomy = 'my_custom_tax';
if (taxonomy_exists($taxonomy)) {
$args = array(
'post_type' => 'post',
'tax_query' => array(
array(
'taxonomy' => $taxonomy,
'field' => 'slug',
'terms' => 'term_slug',
),
),
);
$query = new WP_Query($args);
}
// このコードは、特定のカスタムタクソノミーが存在する場合にカスタムクエリを実行するサンプルです。
URL: なし