WP_Tax_Query

Description

Properties · 7

$queriesarraypublic

Array of taxonomy queries.

$relationstringpublic

The relation between the queries. Can be one of 'AND' or 'OR'.

$no_resultsarray<string,private static

Standard response when the query should not return any rows.

$table_aliasesarrayprotected

A flat list of table aliases used in the JOIN clauses.

$queried_termsarraypublic

Terms and taxonomies fetched by this query.

$primary_tablestringpublic

Database table that where the metadata's objects are stored (eg $wpdb->users).

$primary_id_columnstringpublic

Column in 'primary_table' that represents the ID of the object.

Methods · 11

• __construct()Constructor.
• sanitize_query()Ensures the 'tax_query' argument passed to the class constructor is well-formed.
• sanitize_relation()Sanitizes a 'relation' operator.
• is_first_order_clause()Determines whether a clause is first-order.
• get_sql()Generates SQL clauses to be appended to a main query.
• get_sql_clauses()Generates SQL clauses to be appended to a main query.
• get_sql_for_query()Generates SQL clauses for a single query array.
• get_sql_for_clause()Generates SQL JOIN and WHERE clauses for a "first-order" query clause.
• find_compatible_table_alias()Identifies an existing table alias that is compatible with the current query clause.
• clean_query()Validates a single query.
• transform_query()Transforms a single query, from one field to another.

Source

View on Trac ↗View on GitHub ↗

22#[AllowDynamicProperties]23class WP_Tax_Query {24 25	/**26	 * Array of taxonomy queries.27	 *28	 * See WP_Tax_Query::__construct() for information on tax query arguments.29	 *30	 * @since 3.1.031	 * @var array32	 */33	public $queries = array();34 35	/**36	 * The relation between the queries. Can be one of 'AND' or 'OR'.37	 *38	 * @since 3.1.039	 * @var string40	 */41	public $relation;42 43	/**44	 * Standard response when the query should not return any rows.45	 *46	 * @since 3.2.047	 * @var array<string, array<string>>48	 */49	private static $no_results = array(50		'join'  => array( '' ),51		'where' => array( '0 = 1' ),52	);53 54	/**55	 * A flat list of table aliases used in the JOIN clauses.56	 *57	 * @since 4.1.058	 * @var array59	 */60	protected $table_aliases = array();61 62	/**63	 * Terms and taxonomies fetched by this query.64	 *65	 * We store this data in a flat array because they are referenced in a66	 * number of places by WP_Query.67	 *68	 * @since 4.1.069	 * @var array70	 */71	public $queried_terms = array();72 73	/**74	 * Database table that where the metadata's objects are stored (eg $wpdb->users).75	 *76	 * @since 4.1.077	 * @var string78	 */79	public $primary_table;80 81	/**82	 * Column in 'primary_table' that represents the ID of the object.83	 *84	 * @since 4.1.085	 * @var string86	 */87	public $primary_id_column;88 89	/**90	 * Constructor.91	 *92	 * @since 3.1.093	 * @since 4.1.0 Added support for `$operator` 'NOT EXISTS' and 'EXISTS' values.94	 *95	 * @param array $tax_query {96	 *     Array of taxonomy query clauses.97	 *98	 *     @type string $relation Optional. The MySQL keyword used to join99	 *                            the clauses of the query. Accepts 'AND', or 'OR'. Default 'AND'.100	 *     @type array  ...$0 {101	 *         An array of first-order clause parameters, or another fully-formed tax query.

History

Introduced in 3.1.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 7.1.0 tag, from src/wp-includes/class-wp-tax-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.