get_objects_in_term( int|int[] $term_ids, string|string[] $taxonomies, array|string $args = array() ): string[]|WP_Error

Retrieves object IDs of valid taxonomy and term.

Description

The strings of $taxonomies must exist before this function will continue.
On failure of finding a valid taxonomy, it will return a WP_Error.

The $terms aren’t checked the same as $taxonomies, but still need to exist for object IDs to be returned.

It is possible to change the order that object IDs are returned by using $args with either ASC or DESC array. The value should be in the key named ‘order’.

Parameters

$term_idsint|int[]required
Term ID or array of term IDs of terms that will be used.
$taxonomiesstring|string[]required
String of taxonomy name or Array of string values of taxonomy names.
$argsarray|stringoptional
Change the order of the object IDs.
  • order string
    Order to retrieve terms. Accepts 'ASC' or 'DESC'. Default 'ASC'.

Default:array()

Return

string[]|WP_Error An array of object IDs as numeric strings on success, WP_Error if the taxonomy does not exist.

More Information

If an object is in more than one of the terms passed to $terms, the results returned will contain duplicate object_ids.

Source

function get_objects_in_term( $term_ids, $taxonomies, $args = array() ) {
	global $wpdb;

	if ( ! is_array( $term_ids ) ) {
		$term_ids = array( $term_ids );
	}
	if ( ! is_array( $taxonomies ) ) {
		$taxonomies = array( $taxonomies );
	}
	foreach ( (array) $taxonomies as $taxonomy ) {
		if ( ! taxonomy_exists( $taxonomy ) ) {
			return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
		}
	}

	$defaults = array( 'order' => 'ASC' );
	$args     = wp_parse_args( $args, $defaults );

	$order = ( 'desc' === strtolower( $args['order'] ) ) ? 'DESC' : 'ASC';

	$term_ids = array_map( 'intval', $term_ids );

	$taxonomies = "'" . implode( "', '", array_map( 'esc_sql', $taxonomies ) ) . "'";
	$term_ids   = "'" . implode( "', '", $term_ids ) . "'";

	$sql = "SELECT tr.object_id FROM $wpdb->term_relationships AS tr INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tt.taxonomy IN ($taxonomies) AND tt.term_id IN ($term_ids) ORDER BY tr.object_id $order";

	$last_changed = wp_cache_get_last_changed( 'terms' );
	$cache_key    = 'get_objects_in_term:' . md5( $sql ) . ":$last_changed";
	$cache        = wp_cache_get( $cache_key, 'term-queries' );
	if ( false === $cache ) {
		$object_ids = $wpdb->get_col( $sql );
		wp_cache_set( $cache_key, $object_ids, 'term-queries' );
	} else {
		$object_ids = (array) $cache;
	}

	if ( ! $object_ids ) {
		return array();
	}
	return $object_ids;
}

Changelog

VersionDescription
2.3.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.