Summery Summery
Constructor.
Syntax Syntax
Description Description
Sets up the term query, based on the query vars passed.
Parameters Parameters
- $query
-
(Optional) Array or query string of term query parameters.
- 'taxonomy'
(string|array) Taxonomy name, or array of taxonomies, to which results should be limited. - 'object_ids'
(int|array) Optional. Object ID, or array of object IDs. Results will be limited to terms associated with these objects. - 'orderby'
(string) Field(s) to order terms by. Accepts term fields ('name', 'slug', 'term_group', 'term_id', 'id', 'description', 'parent'), 'count' for term taxonomy count, 'include' to match the 'order' of the $include param, 'slug__in' to match the 'order' of the $slug param, 'meta_value', 'meta_value_num', the value of$meta_key
, or 'none' to omit the ORDER BY clause. Defaults to 'name'., the array keys of
$meta_query - 'order'
(string) Whether to order terms in ascending or descending order. Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'. - 'hide_empty'
(bool|int) Whether to hide terms not assigned to any posts. Accepts 1|true or 0|false. Default 1|true. - 'include'
(array|string) Array or comma/space-separated string of term ids to include. Default empty array. - 'exclude'
(array|string) Array or comma/space-separated string of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. - 'exclude_tree'
(array|string) Array or comma/space-separated string of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. - 'number'
(int|string) Maximum number of terms to return. Accepts ''|0 (all) or any positive number. Default ''|0 (all). Note that $number may not return accurate results when coupled with $object_ids. See #41796 for details. - 'offset'
(int) The number by which to offset the terms query. - 'fields'
(string) Term fields to query for. Accepts: - 'all' Returns an array of complete term objects (WP_Term[]
). Default 'all'.). - 'all_with_object_id' Returns an array of term objects with the 'object_id' param (
string[]WP_Term[]
). Works only when the$object_ids
parameter is populated. - 'ids' Returns an array of term IDs (int[]
). - 'tt_ids' Returns an array of term taxonomy IDs (int[]
). - 'names' Returns an array of term names (string[]
). - 'slugs' Returns an array of term slugs (string[]
). - 'count' Returns the number of matching terms (int
). - 'id=>parent' Returns an associative array of parent term IDs, keyed by term ID (int[]
). - 'id=>name' Returns an associative array of term names, keyed by term ID (string[]
). - 'id=>slug' Returns an associative array of term slugs, keyed by term ID ( - 'count'
(bool) Whether to return a term count. Will take precedence over$fields
if true. Default false. - 'name'
(string|array) Optional. Name or array of names to return term(s) for. - 'slug'
(string|array) Optional. Slug or array of slugs to return term(s) for. - 'term_taxonomy_id'
(int|array) Optional. Term taxonomy ID, or array of term taxonomy IDs, to match when querying terms. - 'hierarchical'
(bool) Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. - 'search'
(string) Search criteria to match terms. Will be SQL-formatted with wildcards before and after. - 'name__like'
(string) Retrieve terms with criteria by which a term is LIKE$name__like
. - 'description__like'
(string) Retrieve terms where the description is LIKE$description__like
. - 'pad_counts'
(bool) Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. - 'get'
(string) Whether to return terms regardless of ancestry or whether the terms are empty. Accepts 'all' or empty (disabled). - 'child_of'
(int) Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. - 'parent'
(int|string) Parent term ID to retrieve direct-child terms of. - 'childless'
(bool) True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. - 'cache_domain'
(string) Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. - 'update_term_meta_cache'
(bool) Whether to prime meta caches for matched terms. Default true. - 'meta_query'
(array) Optional. Meta query clauses to limit retrieved terms by. SeeWP_Meta_Query
. - 'meta_key'
(string) Limit terms to those matching a specific metadata key. Can be used in conjunction with$meta_value
. - 'meta_value'
(string) Limit terms to those matching a specific metadata value. Usually used in conjunction with$meta_key
. - 'meta_type'
(string) MySQL data type that the$meta_value
will be CAST to for comparisons. - 'meta_compare'
(string) Comparison operator to test the 'meta_value'.
Default value: ''
- 'taxonomy'
Source Source
File: wp-includes/class-wp-term-query.php
* @type string $meta_key Limit terms to those matching a specific metadata key. * Can be used in conjunction with `$meta_value`. Default empty. * @type string $meta_value Limit terms to those matching a specific metadata value. * Usually used in conjunction with `$meta_key`. Default empty. * @type string $meta_type MySQL data type that the `$meta_value` will be CAST to for * comparisons. Default empty. * @type string $meta_compare Comparison operator to test the 'meta_value'. Default empty. * } */ public function __construct( $query = '' ) { $this->query_var_defaults = array( 'taxonomy' => null, 'object_ids' => null, 'orderby' => 'name', 'order' => 'ASC', 'hide_empty' => true, 'include' => array(), 'exclude' => array(), 'exclude_tree' => array(), 'number' => '', 'offset' => '', 'fields' => 'all', 'count' => false, 'name' => '', 'slug' => '', 'term_taxonomy_id' => '', 'hierarchical' => true, 'search' => '', 'name__like' => '', 'description__like' => '', 'pad_counts' => false, 'get' => '', 'child_of' => 0, 'parent' => '', 'childless' => false, 'cache_domain' => 'core', 'update_term_meta_cache' => true, 'meta_query' => '', 'meta_key' => '',
Advertisement
Changelog Changelog
Version | Description |
---|---|
4.9.0 | Added 'slug__in' support for 'orderby'. |
4.7.0 | Introduced 'object_ids' parameter. |
4.6.0 | Introduced. |