関数リファレンス/cat is ancestor of

説明

この条件分岐タグは、カテゴリーが他のカテゴリーの「先祖」カテゴリーであるかどうかをチェックします。真偽値を返す関数のため、TRUE または FALSE を返します。

使い方

<?php cat_is_ancestor_of( $cat1, $cat2 ); ?>

パラメータ

$cat1

（整数/オブジェクト） （必須） 親かどうかをチェックしたいカテゴリーの、カテゴリー ID またはカテゴリーオブジェクト。

初期値： なし

$cat2

（整数/オブジェクト） （必須） 子カテゴリー。

初期値： なし

戻り値

(真偽値) 

cat1 が cat2 の親または先祖である場合は TRUE、そうでない場合は FALSE。

用例

この例はあるテーマの archive.php に書かれたもので、表示中のカテゴリーに応じて異なるコンテンツを表示するために条件分岐タグを使います。これはあるカテゴリーの任意の子カテゴリーについてのみ何かの情報を表示するときに便利です。このタグを使わなければ子カテゴリーすべてに category-slug.php ファイルを作る必要があります。

次の小さなコードは 'Music'（ID 4）というカテゴリーが処理中であるかチェックします。そして Music と Music のサブカテゴリー（例えば jazz、classical）のアーカイブページに wp_nav_menu を表示します。

<?php 
  // カテゴリーが music または music のサブカテゴリー
  if ( cat_is_ancestor_of( 4, $cat ) or is_category( 4 ) ) :  ?>
  <div id="music_subnav_menu" class="subnav_menu">
    <?php wp_nav_menu( array( 'menu' => 'Music' ) ); ?>
  </div>
<?php endif; ?>

参考

• この関数は 2 番目に指定したカテゴリーが 1 番目に指定したカテゴリーの子または子孫であるかどうかを評価します。
• どれほど遠いレベルの先祖であっても TRUE を返します。
• パラメータの値は整数値またはオブジェクトでなければなりません。もしパラメータに整数値ではなく、文字表現された整数を指定した場合、cat_is_ancestor_of() は FALSE を返します。

変更履歴

新規導入: 2.1.0

ソースファイル

cat_is_ancestor_of() は wp-includes/category.php に含まれています。

関連

条件分岐タグ： is_404(), is_admin(), is_admin_bar_showing(), is_archive(), is_attachment(), is_author(), is_category(), is_comments_popup(), is_date(), is_day(), is_feed(), is_front_page(), is_home(), is_local_attachment(), is_main_query, /is_multi_author, is_month(), is_new_day(), is_page(), is_page_template(), is_paged(), is_plugin_active(), is_plugin_active_for_network() /en, is_plugin_inactive() /en, is_plugin_page() /en, is_post_type_archive(), is_preview() /en, is_search(), is_single(), is_singular(), is_sticky(), is_tag(), is_tax(), is_taxonomy_hierarchical(), is_time(), is_trackback(), is_year(), in_category(), in_the_loop(), is_active_sidebar(), is_active_widget(), is_blog_installed() /en, is_rtl(), is_dynamic_sidebar(), is_user_logged_in(), has_excerpt(), has_post_thumbnail(), has_tag(), pings_open(), email_exists(), post_type_exists(), taxonomy_exists(), term_exists(), username_exists() /en, wp_attachment_is_image(), wp_script_is()

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function_Reference/cat_is_ancestor_of （最新版との差分）