Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: get_ancestors

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

This hook occurs 2 times in this file.

Line Code
3389  * @param string $object_type The type of object for which we'll be retrieving ancestors.
3390  * @return array of ancestors from lowest to highest in the hierarchy.
3391  */
3392 function get_ancestors($object_id = 0, $object_type = '') {
3393      $object_id = (int) $object_id;
3394
3395      $ancestors = array();
3396
3397      if ( empty( $object_id ) ) {
3398           return apply_filters('get_ancestors', $ancestors, $object_id, $object_type);
3399      }
3400
3401      if ( is_taxonomy_hierarchical( $object_type ) ) {
3402           $term = get_term($object_id, $object_type);
3403           while ( ! is_wp_error($term) && ! empty( $term->parent ) && ! in_array( $term->parent, $ancestors ) ) {
3404                $ancestors[] = (int) $term->parent;
3405                $term = get_term($term->parent, $object_type);
3406           }
3407      } elseif ( post_type_exists( $object_type ) ) {
3408           $ancestors = get_post_ancestors($object_id);
3409      }
3410
3411      return apply_filters('get_ancestors', $ancestors, $object_id, $object_type);
3412 }
3413
3414 /**
3415  * Returns the term's parent's term_ID
3416  *
3417  * @since 3.1.0
3418  *
3419  * @param int $term_id
3420  * @param string $taxonomy