Codex

Function Reference/cat is ancestor of

Contents

Description

This Conditional Tag Check if a category is an ancestor of another category. This is a boolean function, meaning it returns either TRUE or FALSE.

Usage

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

Parameters

$cat1
(int/object) (required) ID or object to check if this is the parent category.
Default: None
$cat2
(int/object) (required) The child category.
Default: None

Return Values

(boolean) 
True if cat1 is an ancestor of cat2, False if not.

Examples

This example, placed in a theme's archive.php, uses Conditional Tags to show different content depending on the category being displayed. This is helpful when it is necessary to include something for any child category of a given category, instead of using category-slug.php method where you'd have to create category-slug.php files for each and every category.

The code snip below checks to see if the category called 'Music' (ID 4) is being processed, and if so, presents a wp_nav_menu for the Music archive page, and any subcategories of Music (e.g. jazz, classical.) 

<?php 
  // if the category is music or a music SUBcategory, 
  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>
<? endif; ?>

Notes

  • The function evaluates if the second category is a child of the first category.
  • Any level of ancestry will return True.
  • Arguments should be either integer or objects, If arguments are string representations of integers and not true integers cat_is_ancestor_of will return False.

Change Log

Since: 2.1.0

Source File

cat_is_ancestor_of() is located in wp-includes/category.php.

Related

Conditional Tags: comments_open(), 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_multi_author, is_month(), is_new_day(), is_page(), is_page_template(), is_paged(), is_plugin_active(), is_plugin_active_for_network(), is_plugin_inactive(), is_plugin_page(), is_post_type_archive(), is_preview(), 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(), 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(), wp_attachment_is_image(), wp_script_is()

See also index of Function Reference and index of Template Tags.
Retrieved from "http://codex.wordpress.org/Function_Reference/cat_is_ancestor_of"

Codex Resources