get_terms
get_terms ( $args = array(), $deprecated = '' )
Parameters:- (array|string) args Optional. Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments. Default empty array.
- (array|string) deprecated Optional. Argument array, when using the legacy function parameter format. If present, this parameter will be interpreted as `$args`, and the first function parameter will be parsed as a taxonomy or array of taxonomies. Default empty.
Returns:- (WP_Term[]|int[]|string[]|string|WP_Error) Array of terms, a count thereof as a numeric string, or WP_Error if any of the taxonomies do not exist. See the function description for more information.
Defined at:Change Log: - Introduced in WordPress: 2.3.0
- Deprecated in WordPress: —
Description
Retrieves the terms in a given taxonomy or list of taxonomies.You can fully inject any customizations to the query before it is sent, as
well as control the output with a filter.
The return type varies depending on the value passed to `$args['fields']`. See
WP_Term_Query::get_terms() for details. In all cases, a `WP_Error` object will
be returned if an invalid taxonomy is requested.
The {@see 'get_terms'} filter will be called when the cache has the term and will
pass the found term along with the array of $taxonomies and array of $args.
This filter is also called before the array of terms is passed and will pass
the array of terms, along with the $taxonomies and $args.
The {@see 'list_terms_exclusions'} filter passes the compiled exclusions along with
the $args.
The {@see 'get_terms_orderby'} filter passes the `ORDER BY` clause for the query
along with the $args array.
Taxonomy or an array of taxonomies should be passed via the 'taxonomy' argument
in the `$args` array:
$terms = get_terms( array(
'taxonomy' => 'post_tag',
'hide_empty' => false,
) );
Prior to 4.5.0, taxonomy was passed as the first parameter of `get_terms()`.