WP_Term_Query

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 9

Every hook that fires from inside WP_Term_Query, in the order it appears in the class, grouped by the method that fires it.

Properties · 7

$requeststringpublic

SQL string used to perform database query.

$meta_queryWP_Meta_Querypublic

Metadata query container.

$meta_query_clausesarrayprotected

Metadata query clauses.

$sql_clausesarrayprotected

SQL query clauses.

$query_varsarraypublic

Query vars set by the user.

$query_var_defaultsarraypublic

Default values for query vars.

$termsarraypublic

List of terms located by the query.

Methods · 11

• __construct()Constructor.
• parse_query()Parse arguments passed to the term query with default query parameters.
• query()Sets up the query and retrieves the results.
• get_terms()Retrieves the query results.
• parse_orderby()Parse and sanitize 'orderby' keys passed to the term query.
• format_terms()Format response depending on field requested.
• parse_orderby_meta()Generate the ORDER BY clause for an 'orderby' param that is potentially related to a meta query.
• parse_order()Parse an 'order' query variable and cast it to ASC or DESC as necessary.
• get_search_sql()Used internally to generate a SQL string related to the 'search' parameter.
• populate_terms()Creates an array of term objects from an array of term IDs.
• generate_cache_key()Generate cache key.

Source code

View on Trac ↗View on GitHub ↗

18#[AllowDynamicProperties]19class WP_Term_Query {20 21	/**22	 * SQL string used to perform database query.23	 *24	 * @since 4.6.025	 * @var string26	 */27	public $request;28 29	/**30	 * Metadata query container.31	 *32	 * @since 4.6.033	 * @var WP_Meta_Query A meta query instance.34	 */35	public $meta_query = false;36 37	/**38	 * Metadata query clauses.39	 *40	 * @since 4.6.041	 * @var array42	 */43	protected $meta_query_clauses;44 45	/**46	 * SQL query clauses.47	 *48	 * @since 4.6.049	 * @var array50	 */51	protected $sql_clauses = array(52		'select'  => '',53		'from'    => '',54		'where'   => array(),55		'orderby' => '',56		'limits'  => '',57	);58 59	/**60	 * Query vars set by the user.61	 *62	 * @since 4.6.063	 * @var array64	 */65	public $query_vars;66 67	/**68	 * Default values for query vars.69	 *70	 * @since 4.6.071	 * @var array72	 */73	public $query_var_defaults;74 75	/**76	 * List of terms located by the query.77	 *78	 * @since 4.6.079	 * @var array80	 */81	public $terms;82 83	/**84	 * Constructor.85	 *86	 * Sets up the term query, based on the query vars passed.87	 *88	 * @since 4.6.089	 * @since 4.6.0 Introduced 'term_taxonomy_id' parameter.90	 * @since 4.7.0 Introduced 'object_ids' parameter.91	 * @since 4.9.0 Added 'slug__in' support for 'orderby'.92	 * @since 5.1.0 Introduced the 'meta_compare_key' parameter.93	 * @since 5.3.0 Introduced the 'meta_type_key' parameter.94	 * @since 6.4.0 Introduced the 'cache_results' parameter.95	 *96	 * @param string|array $query {97	 *     Optional. Array or query string of term query parameters. Default empty.

Changelog

Introduced in 4.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-term-query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.