WP_Meta_Query::__construct( array $meta_query = array() )

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: array()

• $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'

Uses · 1

• WP_Meta_Query::sanitize_query()Ensures the 'meta_query' argument passed to the class constructor is well-formed.

Used by · 7

• WP_Comment_Query::get_comments()Get a list of comments matching the query vars.
• WP_Meta_Query::parse_query_vars()Constructs a meta query based on 'meta_*' query vars
• WP_Query::get_posts()Retrieves an array of posts based on query variables.
• WP_Site_Query::get_sites()Retrieves a list of sites matching the query vars.
• WP_Term_Query::get_terms()Retrieves the query results.
• WP_User_Query::prepare_query()Prepares the query variables.
• get_meta_sql()Given a meta query, generates SQL clauses to be appended to a main query.

Source

View on Trac ↗View on GitHub ↗

168	public function __construct( $meta_query = array() ) {169		if ( ! $meta_query ) {170			return;171		}172 173		if ( isset( $meta_query['relation'] ) && 'OR' === strtoupper( $meta_query['relation'] ) ) {174			$this->relation = 'OR';175		} else {176			$this->relation = 'AND';177		}178 179		$this->queries = $this->sanitize_query( $meta_query );180	}

History

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.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 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.