wppaste
WordPress

WP_Tax_Query::__construct( array $tax_query )

Since
3.1.0, 4.1.0
Source
wp-includes/class-wp-tax-query.php:115
Constructor.

Compatibility

WordPress
since 4.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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.

Performance profile

How much work a call to WP_Tax_Query::__construct() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
11–17

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 19.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

2 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Tax_Query::__construct() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
!isset($tax_query)11->sanitize_query()
isset($tax_query)17->sanitize_relation(), ->sanitize_query()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 19 instructions, 11–17 executed per call, 1 branch. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Used by · 2

Source code

View on Trac View on GitHub 

	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 );	}

Changelog

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.

4.1.0
Added support for $operator 'NOT EXISTS' and 'EXISTS' values.from the docblock
3.1.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 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.