WordPress at a glance

get_ancestors() WP 1.0

Get an array of ancestor IDs for a given object.

  • Since 4.1.0 Introduced the $resource_type argument.
Is the basis for: get_term_parents_list()
✈ 1 time = 0.001263s = very slow | 50000 times = 1.27s = fast PHP 7.0.5, WP 4.5.1
Hooks from function:
Return

Array. An array of ancestors from lowest to highest in the hierarchy.

Usage

get_ancestors( $object_id, $object_type, $resource_type );
$object_id(int)
The ID of the object.
Default: 0
$object_type(string)
The type of object for which we'll be retrieving ancestors. Accepts a post type or a taxonomy name.
Default: ''
$resource_type(string)
Type of resource $object_type is. Accepts 'post_type' or 'taxonomy'.
Default: ''

Code of get_ancestors: wp-includes/taxonomy.php VER 4.9.8

<?php
function get_ancestors( $object_id = 0, $object_type = '', $resource_type = '' ) {
	$object_id = (int) $object_id;

	$ancestors = array();

	if ( empty( $object_id ) ) {

		/** This filter is documented in wp-includes/taxonomy.php */
		return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
	}

	if ( ! $resource_type ) {
		if ( is_taxonomy_hierarchical( $object_type ) ) {
			$resource_type = 'taxonomy';
		} elseif ( post_type_exists( $object_type ) ) {
			$resource_type = 'post_type';
		}
	}

	if ( 'taxonomy' === $resource_type ) {
		$term = get_term($object_id, $object_type);
		while ( ! is_wp_error($term) && ! empty( $term->parent ) && ! in_array( $term->parent, $ancestors ) ) {
			$ancestors[] = (int) $term->parent;
			$term = get_term($term->parent, $object_type);
		}
	} elseif ( 'post_type' === $resource_type ) {
		$ancestors = get_post_ancestors($object_id);
	}

	/**
	 * Filters a given object's ancestors.
	 *
	 * @since 3.1.0
	 * @since 4.1.1 Introduced the `$resource_type` parameter.
	 *
	 * @param array  $ancestors     An array of object ancestors.
	 * @param int    $object_id     Object ID.
	 * @param string $object_type   Type of object.
	 * @param string $resource_type Type of resource $object_type is.
	 */
	return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
}

Related Functions

From tag: Relations (of posts terms...)

More from category: Taxonomies (Categories, Tags)

No comments
    Hello, !     Log In . Register