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
4800  */
4801 function get_ancestors( $object_id = 0, $object_type = '', $resource_type = '' ) {
4802      $object_id = (int) $object_id;
4803
4804      $ancestors = array();
4805
4806      if ( empty( $object_id ) ) {
4807
4808           /** This filter is documented in wp-includes/taxonomy.php */
4809           return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
4810      }
4811
4812      if ( ! $resource_type ) {
4813           if ( is_taxonomy_hierarchical( $object_type ) ) {
4814                $resource_type = 'taxonomy';
4815           } elseif ( post_type_exists( $object_type ) ) {
4816                $resource_type = 'post_type';
4817           }
4818      }
 
Line Code
4832       *
4833       * @since 3.1.0
4834       * @since 4.1.1 Introduced the `$resource_type` parameter.
4835       *
4836       * @param array  $ancestors     An array of object ancestors.
4837       * @param int    $object_id     Object ID.
4838       * @param string $object_type   Type of object.
4839       * @param string $resource_type Type of resource $object_type is.
4840       */
4841      return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
4842 }
4843
4844 /**
4845  * Returns the term's parent's term_ID.
4846  *
4847  * @since 3.1.0
4848  *
4849  * @param int    $term_id  Term ID.
4850  * @param string $taxonomy Taxonomy name.