WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/get objects in term

Contents

Description

Retrieves the object_id(s) belonging to a term in a taxonomy. Which Objects have the given term from the given taxonomy.

The strings of $taxonomies must exist before this function will continue. On failure of finding a valid taxonomy, it will return an WP_Error class, kind of like Exceptions in PHP 5, except you can't catch them. Even so, you can still test for the WP_Error class and get the error message.

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 is returned by either using PHP sort family functions or using the database by using $args with either ASC or DESC array. The value should be in the key named 'order'.

Usage

<?php get_objects_in_term$term_ids$taxonomies$args ?>

Parameters

$term_ids
(integer|array) (required) Term id or array of term ids of terms that will be used
Default: None
$taxonomies
(string|array) (required) String of taxonomy name or Array of string values of taxonomy names
Default: None
$args
(array) (optional) Change what is returned
Default: array()

Possible Arguments

order 
(string)
  • ASC - Default
  • DESC

NOTE: Arguments are passed in the format used by wp_parse_args(). e.g.

Return Values

(WP_Error|array) 
If the taxonomy does not exist, then WP_Error will be returned. On success the array can be empty meaning that there are no $object_ids found or it will return an array of the $object_ids found.

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

Examples

Notes

Change Log

Since: 2.3.0

Source File

get_objects_in_term() is located in /wp-includes/taxonomy.php.

Related

See also index of Function Reference and index of Template Tags.