Ticket #5304: all-filters.txt

Array or query string of term query parameters. Default empty. <ul class="param-hash"><li><b>'taxonomy'</b><br /><i><span class='type'>(string|array)</span></i> Taxonomy name, or array of taxonomies, to which results should be limited.</li>
<li><b>'object_ids'</b><br /><i><span class='type'>(int|array)</span></i> Optional. Object ID, or array of object IDs. Results will be limited to terms associated with these objects.</li>
<li><b>'orderby'</b><br /><i><span class='type'>(string)</span></i> 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 <code>$meta_key <code>, the array keys of </code>$meta_query</code>, or 'none' to omit the ORDER BY clause. Defaults to 'name'.</li>
<li><b>'order'</b><br /><i><span class='type'>(string)</span></i> Whether to order terms in ascending or descending order. Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'.</li>
<li><b>'hide_empty'</b><br /><i><span class='type'>(bool|int)</span></i> Whether to hide terms not assigned to any posts. Accepts 1|true or 0|false. Default 1|true.</li>
<li><b>'include'</b><br /><i><span class='type'>(array|string)</span></i> Array or comma/space-separated string of term ids to include. Default empty array.</li>
<li><b>'exclude'</b><br /><i><span class='type'>(array|string)</span></i> Array or comma/space-separated string of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array.</li>
<li><b>'exclude_tree'</b><br /><i><span class='type'>(array|string)</span></i> 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.</li>
<li><b>'number'</b><br /><i><span class='type'>(int|string)</span></i> 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.</li>
<li><b>'offset'</b><br /><i><span class='type'>(int)</span></i> The number by which to offset the terms query. Default empty.</li>
<li><b>'fields'</b><br /><i><span class='type'>(string)</span></i> Term fields to query for. Accepts: - 'all' Returns an array of complete term objects (<code>WP_Term[] <code>). - 'all_with_object_id' Returns an array of term objects with the 'object_id' param (<code>WP_Term[]</code>). Works only when the <code>$object_ids</code> parameter is populated. - 'ids' Returns an array of term IDs (<code>int[]</code>). - 'tt_ids' Returns an array of term taxonomy IDs (<code>int[]</code>). - 'names' Returns an array of term names (<code>string[]</code>). - 'slugs' Returns an array of term slugs (<code>string[]</code>). - 'count' Returns the number of matching terms (<code>int</code>). - 'id=&gt;parent' Returns an associative array of parent term IDs, keyed by term ID (<code>int[]</code>). - 'id=&gt;name' Returns an associative array of term names, keyed by term ID (<code>string[]</code>). - 'id=&gt;slug' Returns an associative array of term slugs, keyed by term ID (</code>string[]</code>). Default 'all'.</li>
<li><b>'count'</b><br /><i><span class='type'>(bool)</span></i> Whether to return a term count. Will take precedence over <code>$fields</code> if true. Default false.</li>
<li><b>'name'</b><br /><i><span class='type'>(string|array)</span></i> Optional. Name or array of names to return term(s) for. Default empty.</li>
<li><b>'slug'</b><br /><i><span class='type'>(string|array)</span></i> Optional. Slug or array of slugs to return term(s) for. Default empty.</li>
<li><b>'term_taxonomy_id'</b><br /><i><span class='type'>(int|array)</span></i> Optional. Term taxonomy ID, or array of term taxonomy IDs, to match when querying terms.</li>
<li><b>'hierarchical'</b><br /><i><span class='type'>(bool)</span></i> Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true.</li>
<li><b>'search'</b><br /><i><span class='type'>(string)</span></i> Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty.</li>
<li><b>'name__like'</b><br /><i><span class='type'>(string)</span></i> Retrieve terms with criteria by which a term is LIKE <code>$name__like</code>. Default empty.</li>
<li><b>'description__like'</b><br /><i><span class='type'>(string)</span></i> Retrieve terms where the description is LIKE <code>$description__like</code>. Default empty.</li>
<li><b>'pad_counts'</b><br /><i><span class='type'>(bool)</span></i> Whether to pad the quantity of a term's children in the quantity of each term's &quot;count&quot; object variable. Default false.</li>
<li><b>'get'</b><br /><i><span class='type'>(string)</span></i> Whether to return terms regardless of ancestry or whether the terms are empty. Accepts 'all' or empty (disabled). Default empty.</li>
<li><b>'child_of'</b><br /><i><span class='type'>(int)</span></i> Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0.</li>
<li><b>'parent'</b><br /><i><span class='type'>(int|string)</span></i> Parent term ID to retrieve direct-child terms of. Default empty.</li>
<li><b>'childless'</b><br /><i><span class='type'>(bool)</span></i> True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false.</li>
<li><b>'cache_domain'</b><br /><i><span class='type'>(string)</span></i> Unique cache key to be produced when this query is stored in an object cache. Default is 'core'.</li>
<li><b>'update_term_meta_cache'</b><br /><i><span class='type'>(bool)</span></i> Whether to prime meta caches for matched terms. Default true.</li>
<li><b>'meta_query'</b><br /><i><span class='type'>(array)</span></i> Optional. Meta query clauses to limit retrieved terms by. See <code><a href="https://developer.wordpress.org/reference/classes/wp_meta_query/">WP_Meta_Query</a></code>. Default empty.</li>
<li><b>'meta_key'</b><br /><i><span class='type'>(string)</span></i> Limit terms to those matching a specific metadata key. Can be used in conjunction with <code>$meta_value</code>. Default empty.</li>
<li><b>'meta_value'</b><br /><i><span class='type'>(string)</span></i> Limit terms to those matching a specific metadata value. Usually used in conjunction with <code>$meta_key</code>. Default empty.</li>
<li><b>'meta_type'</b><br /><i><span class='type'>(string)</span></i> MySQL data type that the <code>$meta_value</code> will be CAST to for comparisons. Default empty.</li>
<li><b>'meta_compare'</b><br /><i><span class='type'>(string)</span></i> Comparison operator to test the 'meta_value'. Default empty.</li>
</li></ul>