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.

  • Action hooks look like this: do_action( "hook_name" )
  • Filter hooks look like this: apply_filters( "hook_name", "what_to_filter" ).

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
4344  */
4345 function get_ancestors( $object_id = 0, $object_type = '', $resource_type = '' ) {
4346      $object_id = (int) $object_id;
4347
4348      $ancestors = array();
4349
4350      if ( empty( $object_id ) ) {
4351
4352           /** This filter is documented in wp-includes/taxonomy.php */
4353           return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
4354      }
4355
4356      if ( ! $resource_type ) {
4357           if ( is_taxonomy_hierarchical( $object_type ) ) {
4358                $resource_type = 'taxonomy';
4359           } elseif ( post_type_exists( $object_type ) ) {
4360                $resource_type = 'post_type';
4361           }
4362      }
 
Line Code
4376       *
4377       * @since 3.1.0
4378       * @since 4.1.1 Introduced the `$resource_type` parameter.
4379       *
4380       * @param array  $ancestors     An array of object ancestors.
4381       * @param int    $object_id     Object ID.
4382       * @param string $object_type   Type of object.
4383       * @param string $resource_type Type of resource $object_type is.
4384       */
4385      return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
4386 }
4387
4388 /**
4389  * Returns the term's parent's term_ID.
4390  *
4391  * @since 3.1.0
4392  *
4393  * @param int    $term_id  Term ID.
4394  * @param string $taxonomy Taxonomy name.