WPDev.one
Core Class

WP_Term_Query

class WP_Term_Query // Constructor: function Object() { [native code] }

Class used for querying terms.

Methods 11 methods

Method / Return Description
__construct()
void

Constructor.

Parameters: $query: mixed
parse_query()
void

Parse arguments passed to the term query with default query parameters.

Parameters: $query: mixed
query()
(WP_Term[]

Sets up the query and retrieves the results.

Parameters: $query: mixed
get_terms()
(WP_Term[]

Retrieves the query results.

parse_orderby()
(string

Parse and sanitize 'orderby' keys passed to the term query.

Parameters: $orderby_raw: mixed
format_terms()
(WP_Term[]

Format response depending on field requested.

Parameters: $term_objects: mixed, $_fields: mixed
parse_orderby_meta()
string

Generate the ORDER BY clause for an 'orderby' param that is potentially related to a meta query.

Parameters: $orderby_raw: mixed
parse_order()
string

Parse an 'order' query variable and cast it to ASC or DESC as necessary.

Parameters: $order: mixed
get_search_sql()
string

Used internally to generate a SQL string related to the 'search' parameter.

Parameters: $search: mixed
populate_terms()
WP_Term[]

Creates an array of term objects from an array of term IDs.

Parameters: $terms: mixed
generate_cache_key()
string

Generate cache key.

Parameters: $args: array, $sql: mixed

Properties

Property / Type Description
$request
mixed
public
No description available.
$meta_query
mixed
public
No description available.
$meta_query_clauses
mixed
public
No description available.
$sql_clauses
mixed
public
No description available.
$query_vars
mixed
public
No description available.
$query_var_defaults
mixed
public
No description available.
$terms
mixed
public
No description available.

Class Information

Since Version
4.6.0
Source File
wp-includes/class-wp-term-query.php
Advertisement