WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Tax_Query::__construct()

WP_Tax_Query::__construct( array $tax_query )

In this article

Back to top

Constructor.

Parameters

$tax_queryarrayrequired
Array of taxonomy query clauses.
  • relation string
    Optional. The MySQL keyword used to join the clauses of the query. Accepts 'AND', or 'OR'. Default 'AND'.
  • ...$0 array
    An array of first-order clause parameters, or another fully-formed tax query.
    • taxonomy string
      Taxonomy being queried. Optional when field=term_taxonomy_id.
    • terms string|int|array
      Term or terms to filter by.
    • field string
      Field to match $terms against. Accepts 'term_id', 'slug', 'name', or 'term_taxonomy_id'. Default: 'term_id'.
    • operator string
      MySQL operator to be used with $terms in the WHERE clause.
      Accepts 'AND', 'IN', ‘NOT IN’, 'EXISTS', ‘NOT EXISTS’.
      Default: 'IN'.
    • include_children bool
      Optional. Whether to include child terms.
      Requires a $taxonomy. Default: true.

Source

public function __construct( $tax_query ) {
	if ( isset( $tax_query['relation'] ) ) {
		$this->relation = $this->sanitize_relation( $tax_query['relation'] );
	} else {
		$this->relation = 'AND';
	}

	$this->queries = $this->sanitize_query( $tax_query );
}

View all references View on Trac View on GitHub

UsesDescription
WP_Tax_Query::sanitize_relation()wp-includes/class-wp-tax-query.php

Sanitizes a ‘relation’ operator.

WP_Tax_Query::sanitize_query()wp-includes/class-wp-tax-query.php

Ensures the ‘tax_query’ argument passed to the class constructor is well-formed.

Used byDescription
WP_Query::parse_tax_query()wp-includes/class-wp-query.php

Parses various taxonomy related query vars.

get_tax_sql()wp-includes/taxonomy.php

Given a taxonomy query, generates SQL to be appended to a main query.

Changelog

VersionDescription
4.1.0Added support for $operator ‘NOT EXISTS’ and 'EXISTS' values.
3.1.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.