wppaste
WordPress

WP_Meta_Query::__construct( array $meta_query = false )

Since
3.2.0, 4.2.0, 5.1.0, 5.3.0
Source
wp-includes/class-wp-meta-query.php:168
Constructor.

Compatibility

WordPress
since 5.3.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

$meta_queryarrayoptional
Array of meta query clauses. When first-order clauses or sub-clauses use strings as their array keys, they may be referenced in the 'orderby' parameter of the parent query.Default: false

  • $relationstring

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

  • $keystring|string[]

    Meta key or keys to filter by.

  • $compare_keystringdefault: is 'IN' when $key is an array, '=' otherwise

    MySQL operator used for comparing the $key. Accepts:
    • '='
    • '!='
    • 'LIKE'
    • 'NOT LIKE'
    • 'IN'
    • 'NOT IN'
    • 'REGEXP'
    • 'NOT REGEXP'
    • 'RLIKE'
    • 'EXISTS' (alias of '=')
    • 'NOT EXISTS' (alias of '!=')

  • $type_keystringdefault: is ''

    MySQL data type that the meta_key column will be CAST to for comparisons. Accepts 'BINARY' for case-sensitive regular expression comparisons.

  • $valuestring|string[]

    Meta value or values to filter by.

  • $comparestringdefault: is 'IN' when $value is an array, '=' otherwise

    MySQL operator used for comparing the $value. Accepts:
    • '='
    • '!='
    • '>'
    • '>='
    • '<'
    • '<='
    • 'LIKE'
    • 'NOT LIKE'
    • 'IN'
    • 'NOT IN'
    • 'BETWEEN'
    • 'NOT BETWEEN'
    • 'REGEXP'
    • 'NOT REGEXP'
    • 'RLIKE'
    • 'EXISTS'
    • 'NOT EXISTS'

  • $typestringdefault: is 'CHAR'. }

    MySQL data type that the meta_value column will be CAST to for comparisons. Accepts:
    • 'NUMERIC'
    • 'BINARY'
    • 'CHAR'
    • 'DATE'
    • 'DATETIME'
    • 'DECIMAL'
    • 'SIGNED'
    • 'TIME'
    • 'UNSIGNED'

Performance profile

How much work a call to WP_Meta_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
3–19

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
7

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

What one call costs · 3 distinct outcomes

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

WhenInstructionsCalls it makes
always3none
!isset($meta_query)12->sanitize_query()
isset($meta_query)18–19strtoupper(), ->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: 22 instructions, 3–19 executed per call, 3 branches. 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 · 1

Used by · 7

Source code

View on Trac View on GitHub 

	public function __construct( $meta_query = false ) {		if ( ! $meta_query ) {			return;		} 		if ( isset( $meta_query['relation'] ) && 'OR' === strtoupper( $meta_query['relation'] ) ) {			$this->relation = 'OR';		} else {			$this->relation = 'AND';		} 		$this->queries = $this->sanitize_query( $meta_query );	}

Changelog

Introduced in 5.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.

5.3.0
Increased the number of operators available to $compare_key. Introduced $type_key, which enables the $key to be cast to a new data type for comparisons.from the docblock
5.1.0
Introduced $compare_key clause parameter, which enables LIKE key matches.from the docblock
4.2.0
Introduced support for naming query clauses by associative array keys.from the docblock
3.2.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-wp-meta-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.