is_object_in_term( int $object_id, string $taxonomy, int|string|int[]|string[] $terms = null ): bool|WP_Error

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$object_idint

ID of the object (post ID, link ID, ...).

$taxonomystring

Single taxonomy name.

$termsint|string|int[]|string[]optional

Term ID, name, slug, or array of such to check against. Default null.Default: null

Return value

bool|WP_Error

WP_Error on input error.

Performance profile

How much work a call to is_object_in_term() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via wp_get_object_terms().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

14–86

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 107.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent querywp_get_object_terms()called directly
• cacheobject cachewp_cache_set()called directly
• hookthird-party callbacksapply_filters()one call below is_object_in_term()

Further down the call graph this can also reach option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 12 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost is_object_in_term() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• __()Retrieves the translation of $text.
• get_object_term_cache()Retrieves the cached term objects for the given object ID.
• wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_cache_set()Saves the data to the cache.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• WP_Error::__construct()Initializes the error.

Used by · 2

• has_term()Checks if the current post has any of given terms.
• wp_update_nav_menu_item()Saves the properties of a menu item or create a new one.

Source code

View on Trac ↗View on GitHub ↗

4944function is_object_in_term( $object_id, $taxonomy, $terms = null ) {4945	$object_id = (int) $object_id;4946	if ( ! $object_id ) {4947		return new WP_Error( 'invalid_object', __( 'Invalid object ID.' ) );4948	}4949 4950	$object_terms = get_object_term_cache( $object_id, $taxonomy );4951	if ( false === $object_terms ) {4952		$object_terms = wp_get_object_terms( $object_id, $taxonomy, array( 'update_term_meta_cache' => false ) );4953		if ( is_wp_error( $object_terms ) ) {4954			return $object_terms;4955		}4956 4957		wp_cache_set( $object_id, wp_list_pluck( $object_terms, 'term_id' ), "{$taxonomy}_relationships" );4958	}4959 4960	if ( is_wp_error( $object_terms ) ) {4961		return $object_terms;4962	}4963 4964	if ( empty( $object_terms ) ) {4965		return false;4966	}4967 4968	if ( empty( $terms ) ) {4969		return true;4970	}4971 4972	$terms = (array) $terms;4973 4974	$ints = array_filter( $terms, 'is_int' );4975	if ( $ints ) {4976		$strs = array_diff( $terms, $ints );4977	} else {4978		$strs =& $terms;4979	}4980 4981	foreach ( $object_terms as $object_term ) {4982		// If term is an int, check against term_ids only.4983		if ( $ints && in_array( $object_term->term_id, $ints, true ) ) {4984			return true;4985		}4986 4987		if ( $strs ) {4988			// Only check numeric strings against term_id, to avoid false matches due to type juggling.4989			$numeric_strs = array_map( 'intval', array_filter( $strs, 'is_numeric' ) );4990			if ( in_array( $object_term->term_id, $numeric_strs, true ) ) {4991				return true;4992			}4993 4994			if ( in_array( $object_term->name, $strs, true ) ) {4995				return true;4996			}4997			if ( in_array( $object_term->slug, $strs, true ) ) {4998				return true;4999			}5000		}5001	}5002 5003	return false;5004}

Changelog

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/taxonomy.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.