概要
is_tax関数は、WordPressのタクソノミーアーカイブページかどうかを調べるための関数です。この関数は主に以下のような場面で使用されます：
- タクソノミーアーカイブの条件分岐。
- カスタムタクソノミーの表示制御。
- SEO関連の設定や最適化。
- タクソノミー特有のスタイリングやスクリプトの読み込み。
- 特定のタクソノミーのコンテンツに対するカスタマイズ。
- アーカイブページ用のナビゲーションやページネーションの実装。
- 特定のタクソノミーに基づいたウィジェットの可視化。
- タクソノミー用のサイドバーやメニューの動的変更。
構文
is_tax( string|array $taxonomy = '', string $term = '' )
パラメータ
$taxonomy(string|array) – チェックするタクソノミーの名前。複数のタクソノミーを指定する場合は配列で渡すことができます。$term(string) – チェックするタームのスラッグ。または用語ID。省略可能です。
戻り値
- (bool) – 引数で指定されたタクソノミーアーカイブである場合は
true、それ以外の場合はfalseを返します。
関連する関数
使用可能なバージョン
is_tax関数はWordPress 3.1.0以降で使用可能です。
コアファイルのパス
wp-includes/query.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 |
例
以下にis_tax関数を使用したサンプルコードを5点紹介します。
サンプルコード1
if ( is_tax( 'genre' ) ) {
echo 'このページはジャンルのタクソノミーアーカイブです';
}
このコードは、現在のページが「ジャンル」タクソノミーのアーカイブページであるかどうかを確認し、該当する場合はメッセージを表示します。
サンプルコード2
if ( is_tax( array( 'genre', 'actor' ) ) ) {
// ジャンルまたはアクターのタクソノミーの場合の処理
add_action( 'wp_head', 'my_custom_styles' );
}
このコードは、現在のページが「ジャンル」または「アクター」タクソノミーのアーカイブページである場合、カスタムスタイルを追加するためのアクションをフックします。
サンプルコード3
if ( is_tax( 'category', 'news' ) ) {
get_template_part( 'content', 'news' );
}
ここでは、「ニュース」というタームを持つカテゴリーのアーカイブページで、特定のテンプレートパートを読み込む処理を行います。
サンプルコード4
if ( is_tax() ) {
// 任意のタクソノミーのアーカイブページの場合の処理
echo '<h1>タクソノミーアーカイブ</h1>';
}
このコードは、現在のページが任意のタクソノミーのアーカイブページである場合に、タイトルを表示します。
サンプルコード5
if ( is_tax( 'product_category', 'electronics' ) ) {
// 電子機器カテゴリーのタクソノミーの場合の処理
add_filter( 'the_content', 'modify_electronics_content' );
}
このコードは、「電子機器」というタームを持つ商品カテゴリーのアーカイブページの場合、コンテンツを修正するためのフィルターを適用します。
参考文献や他のサンプルについては、WordPressの公式ドキュメントや開発者向けのリソースを参照してください。