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
4118  */
4119 function get_ancestors( $object_id = 0, $object_type = '', $resource_type = '' ) {
4120      $object_id = (int) $object_id;
4121
4122      $ancestors = array();
4123
4124      if ( empty( $object_id ) ) {
4125
4126           /** This filter is documented in wp-includes/taxonomy.php */
4127           return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
4128      }
4129
4130      if ( ! $resource_type ) {
4131           if ( is_taxonomy_hierarchical( $object_type ) ) {
4132                $resource_type = 'taxonomy';
4133           } elseif ( post_type_exists( $object_type ) ) {
4134                $resource_type = 'post_type';
4135           }
4136      }
 
Line Code
4150       *
4151       * @since 3.1.0
4152       * @since 4.1.1 Introduced the `$resource_type` parameter.
4153       *
4154       * @param array  $ancestors     An array of object ancestors.
4155       * @param int    $object_id     Object ID.
4156       * @param string $object_type   Type of object.
4157       * @param string $resource_type Type of resource $object_type is.
4158       */
4159      return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
4160 }
4161
4162 /**
4163  * Returns the term's parent's term_ID.
4164  *
4165  * @since 3.1.0
4166  *
4167  * @param int    $term_id  Term ID.
4168  * @param string $taxonomy Taxonomy name.