WP_Tax_Query::__construct( array $tax_query )

Parameters

$tax_queryarray

Array of taxonomy query clauses.

• $relationstring

  Optional. The MySQL keyword used to join the clauses of the query. Accepts 'AND', or 'OR'. Default 'AND'. @type array ...$0 { An array of first-order clause parameters, or another fully-formed tax query.

• $taxonomystring

  Taxonomy being queried. Optional when field=term_taxonomy_id.

• $termsstring|int|array

  Term or terms to filter by.

• $fieldstringdefault: 'term_id'

  Field to match $terms against. Accepts 'term_id', 'slug', 'name', or 'term_taxonomy_id'.

• $operatorstringdefault: 'IN'

  MySQL operator to be used with $terms in the WHERE clause. Accepts 'AND', 'IN', 'NOT IN', 'EXISTS', 'NOT EXISTS'.

• $include_childrenbooldefault: true. }

  Optional. Whether to include child terms. Requires a $taxonomy.

Uses · 2

• WP_Tax_Query::sanitize_relation()Sanitizes a 'relation' operator.
• WP_Tax_Query::sanitize_query()Ensures the 'tax_query' argument passed to the class constructor is well-formed.

Used by · 2

• WP_Query::parse_tax_query()Parses various taxonomy related query vars.
• get_tax_sql()Given a taxonomy query, generates SQL to be appended to a main query.

Source

View on Trac ↗View on GitHub ↗

115	public function __construct( $tax_query ) {116		if ( isset( $tax_query['relation'] ) ) {117			$this->relation = $this->sanitize_relation( $tax_query['relation'] );118		} else {119			$this->relation = 'AND';120		}121 122		$this->queries = $this->sanitize_query( $tax_query );123	}

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.