Schema Documentation
RootQueryToPostFormatConnectionWhereArgs
Description
Arguments for filtering the RootQueryToPostFormatConnection connection
Fields
Input Field | Description |
---|---|
cacheDomain - String | Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int | Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean | True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String | Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID] | Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID] | Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean | Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean | Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID] | Array of term ids to include. Default empty array. |
name - [String] | Array of names to return term(s) for. Default empty. |
nameLike - String | Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID] | Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum | Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum | Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean | Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int | Parent term ID to retrieve direct-child terms of. Default empty. |
search - String | Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String] | Array of slugs to return term(s) for. Default empty. |
termTaxonomId - [ID] | Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID] | Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean | Whether to prime meta caches for matched terms. Default true. |
Example
{"cacheDomain":"abc123","childOf":123,"childless":true,"descriptionLike":"abc123","exclude":["4"],"excludeTree":["4"],"hideEmpty":false,"hierarchical":true,"include":["4"],"name":["xyz789"],"nameLike":"xyz789","objectIds":["4"],"order":"ASC","orderby":"COUNT","padCounts":true,"parent":123,"search":"abc123","slug":["abc123"],"termTaxonomId":[4],"termTaxonomyId":["4"],"updateTermMetaCache":true}