873
* Class for generating SQL clauses that filter a primary query according to metadata keys and values.
875
* `WP_Meta_Query` is a helper that allows primary query classes, such as {@see WP_Query} and {@see WP_User_Query},
876
* to filter their results by object metadata, by generating `JOIN` and `WHERE` subclauses to be attached
877
* to the primary SQL query string.
881
class WP_Meta_Query {
883
* Array of metadata queries.
885
* See {@see WP_Meta_Query::__construct()} for information on meta query arguments.
891
public $queries = array();
894
* The relation between the queries. Can be one of 'AND' or 'OR'.
903
* Database table to query for the metadata.
912
* Column in meta_table that represents the ID of the object the metadata belongs to.
918
public $meta_id_column;
921
* Database table that where the metadata's objects are stored (eg $wpdb->users).
927
public $primary_table;
930
* Column in primary_table that represents the ID of the object.
936
public $primary_id_column;
939
* A flat list of table aliases used in JOIN clauses.
945
protected $table_aliases = array();
948
* A flat list of clauses, keyed by clause 'name'.
954
protected $clauses = array();
957
* Whether the query contains any OR relations.
963
protected $has_or_relation = false;
969
* @since 4.2.0 Introduced support for naming query clauses by associative array keys.
973
* @param array $meta_query {
974
* Array of meta query clauses. When first-order clauses use strings as their array keys, they may be
975
* referenced in the 'orderby' parameter of the parent query.
977
* @type string $relation Optional. The MySQL keyword used to join
978
* the clauses of the query. Accepts 'AND', or 'OR'. Default 'AND'.
980
* Optional. An array of first-order clause parameters, or another fully-formed meta query.
982
* @type string $key Meta key to filter by.
983
* @type string $value Meta value to filter by.
984
* @type string $compare MySQL operator used for comparing the $value. Accepts '=',
985
* '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN',
986
* 'BETWEEN', 'NOT BETWEEN', 'REGEXP', 'NOT REGEXP', or 'RLIKE'.
987
* Default is 'IN' when `$value` is an array, '=' otherwise.
988
* @type string $type MySQL data type that the meta_value column will be CAST to for
989
* comparisons. Accepts 'NUMERIC', 'BINARY', 'CHAR', 'DATE',
990
* 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', or 'UNSIGNED'.
995
public function __construct( $meta_query = false ) {
999
if ( isset( $meta_query['relation'] ) && strtoupper( $meta_query['relation'] ) == 'OR' ) {
1000
$this->relation = 'OR';
1002
$this->relation = 'AND';
1005
$this->queries = $this->sanitize_query( $meta_query );
1009
* Ensure the 'meta_query' argument passed to the class constructor is well-formed.
1011
* Eliminates empty items and ensures that a 'relation' is set.
1016
* @param array $queries Array of query clauses.
1017
* @return array Sanitized array of query clauses.
1019
public function sanitize_query( $queries ) {
1020
$clean_queries = array();
1022
if ( ! is_array( $queries ) ) {
1023
return $clean_queries;
1026
foreach ( $queries as $key => $query ) {
1027
if ( 'relation' === $key ) {
1030
} elseif ( ! is_array( $query ) ) {
1033
// First-order clause.
1034
} elseif ( $this->is_first_order_clause( $query ) ) {
1035
if ( isset( $query['value'] ) && array() === $query['value'] ) {
1036
unset( $query['value'] );
1039
$clean_queries[ $key ] = $query;
1041
// Otherwise, it's a nested query, so we recurse.
1043
$cleaned_query = $this->sanitize_query( $query );
1045
if ( ! empty( $cleaned_query ) ) {
1046
$clean_queries[ $key ] = $cleaned_query;
1051
if ( empty( $clean_queries ) ) {
1052
return $clean_queries;
1055
// Sanitize the 'relation' key provided in the query.
1056
if ( isset( $relation ) && 'OR' === strtoupper( $relation ) ) {
1057
$clean_queries['relation'] = 'OR';
1058
$this->has_or_relation = true;
1061
* If there is only a single clause, call the relation 'OR'.
1062
* This value will not actually be used to join clauses, but it
1063
* simplifies the logic around combining key-only queries.
1065
} elseif ( 1 === count( $clean_queries ) ) {
1066
$clean_queries['relation'] = 'OR';
1070
$clean_queries['relation'] = 'AND';
1073
return $clean_queries;
1077
* Determine whether a query clause is first-order.
1079
* A first-order meta query clause is one that has either a 'key' or
1080
* a 'value' array key.
1085
* @param array $query Meta query arguments.
1086
* @return bool Whether the query clause is a first-order clause.
1088
protected function is_first_order_clause( $query ) {
1089
return isset( $query['key'] ) || isset( $query['value'] );
1093
* Constructs a meta query based on 'meta_*' query vars
1098
* @param array $qv The query variables
1100
public function parse_query_vars( $qv ) {
1101
$meta_query = array();
1104
* For orderby=meta_value to work correctly, simple query needs to be
1105
* first (so that its table join is against an unaliased meta table) and
1106
* needs to be its own clause (so it doesn't interfere with the logic of
1107
* the rest of the meta_query).
1109
$primary_meta_query = array();
1110
foreach ( array( 'key', 'compare', 'type' ) as $key ) {
1111
if ( ! empty( $qv[ "meta_$key" ] ) ) {
1112
$primary_meta_query[ $key ] = $qv[ "meta_$key" ];
1116
// WP_Query sets 'meta_value' = '' by default.
1117
if ( isset( $qv['meta_value'] ) && '' !== $qv['meta_value'] && ( ! is_array( $qv['meta_value'] ) || $qv['meta_value'] ) ) {
1118
$primary_meta_query['value'] = $qv['meta_value'];
1121
$existing_meta_query = isset( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ? $qv['meta_query'] : array();
1123
if ( ! empty( $primary_meta_query ) && ! empty( $existing_meta_query ) ) {
1124
$meta_query = array(
1125
'relation' => 'AND',
1126
$primary_meta_query,
1127
$existing_meta_query,
1129
} elseif ( ! empty( $primary_meta_query ) ) {
1130
$meta_query = array(
1131
$primary_meta_query,
1133
} elseif ( ! empty( $existing_meta_query ) ) {
1134
$meta_query = $existing_meta_query;
1137
$this->__construct( $meta_query );
1141
* Return the appropriate alias for the given meta type if applicable.
1146
* @param string $type MySQL type to cast meta_value.
1147
* @return string MySQL type.
1149
public function get_cast_for_type( $type = '' ) {
1150
if ( empty( $type ) )
1153
$meta_type = strtoupper( $type );
1155
if ( ! preg_match( '/^(?:BINARY|CHAR|DATE|DATETIME|SIGNED|UNSIGNED|TIME|NUMERIC(?:\(\d+(?:,\s?\d+)?\))?|DECIMAL(?:\(\d+(?:,\s?\d+)?\))?)$/', $meta_type ) )
1158
if ( 'NUMERIC' == $meta_type )
1159
$meta_type = 'SIGNED';
1165
* Generates SQL clauses to be appended to a main query.
1170
* @param string $type Type of meta, eg 'user', 'post'.
1171
* @param string $primary_table Database table where the object being filtered is stored (eg wp_users).
1172
* @param string $primary_id_column ID column for the filtered object in $primary_table.
1173
* @param object $context Optional. The main query object.
1174
* @return false|array {
1175
* Array containing JOIN and WHERE SQL clauses to append to the main query.
1177
* @type string $join SQL fragment to append to the main JOIN clause.
1178
* @type string $where SQL fragment to append to the main WHERE clause.
1181
public function get_sql( $type, $primary_table, $primary_id_column, $context = null ) {
1182
if ( ! $meta_table = _get_meta_table( $type ) ) {
1186
$this->meta_table = $meta_table;
1187
$this->meta_id_column = sanitize_key( $type . '_id' );
1189
$this->primary_table = $primary_table;
1190
$this->primary_id_column = $primary_id_column;
1192
$sql = $this->get_sql_clauses();
1195
* If any JOINs are LEFT JOINs (as in the case of NOT EXISTS), then all JOINs should
1196
* be LEFT. Otherwise posts with no metadata will be excluded from results.
1198
if ( false !== strpos( $sql['join'], 'LEFT JOIN' ) ) {
1199
$sql['join'] = str_replace( 'INNER JOIN', 'LEFT JOIN', $sql['join'] );
1203
* Filter the meta query's generated SQL.
1207
* @param array $args {
1208
* An array of meta query SQL arguments.
1210
* @type array $clauses Array containing the query's JOIN and WHERE clauses.
1211
* @type array $queries Array of meta queries.
1212
* @type string $type Type of meta.
1213
* @type string $primary_table Primary table.
1214
* @type string $primary_id_column Primary column ID.
1215
* @type object $context The main query object.
1218
return apply_filters_ref_array( 'get_meta_sql', array( $sql, $this->queries, $type, $primary_table, $primary_id_column, $context ) );
1222
* Generate SQL clauses to be appended to a main query.
1224
* Called by the public {@see WP_Meta_Query::get_sql()}, this method
1225
* is abstracted out to maintain parity with the other Query classes.
1231
* Array containing JOIN and WHERE SQL clauses to append to the main query.
1233
* @type string $join SQL fragment to append to the main JOIN clause.
1234
* @type string $where SQL fragment to append to the main WHERE clause.
1237
protected function get_sql_clauses() {
1239
* $queries are passed by reference to get_sql_for_query() for recursion.
1240
* To keep $this->queries unaltered, pass a copy.
1242
$queries = $this->queries;
1243
$sql = $this->get_sql_for_query( $queries );
1245
if ( ! empty( $sql['where'] ) ) {
1246
$sql['where'] = ' AND ' . $sql['where'];
1253
* Generate SQL clauses for a single query array.
1255
* If nested subqueries are found, this method recurses the tree to
1256
* produce the properly nested SQL.
1261
* @param array $query Query to parse, passed by reference.
1262
* @param int $depth Optional. Number of tree levels deep we currently are.
1263
* Used to calculate indentation. Default 0.
1265
* Array containing JOIN and WHERE SQL clauses to append to a single query array.
1267
* @type string $join SQL fragment to append to the main JOIN clause.
1268
* @type string $where SQL fragment to append to the main WHERE clause.
1271
protected function get_sql_for_query( &$query, $depth = 0 ) {
1272
$sql_chunks = array(
1283
for ( $i = 0; $i < $depth; $i++ ) {
1287
foreach ( $query as $key => &$clause ) {
1288
if ( 'relation' === $key ) {
1289
$relation = $query['relation'];
1290
} elseif ( is_array( $clause ) ) {
1292
// This is a first-order clause.
1293
if ( $this->is_first_order_clause( $clause ) ) {
1294
$clause_sql = $this->get_sql_for_clause( $clause, $query, $key );
1296
$where_count = count( $clause_sql['where'] );
1297
if ( ! $where_count ) {
1298
$sql_chunks['where'][] = '';
1299
} elseif ( 1 === $where_count ) {
1300
$sql_chunks['where'][] = $clause_sql['where'][0];
1302
$sql_chunks['where'][] = '( ' . implode( ' AND ', $clause_sql['where'] ) . ' )';
1305
$sql_chunks['join'] = array_merge( $sql_chunks['join'], $clause_sql['join'] );
1306
// This is a subquery, so we recurse.
1308
$clause_sql = $this->get_sql_for_query( $clause, $depth + 1 );
1310
$sql_chunks['where'][] = $clause_sql['where'];
1311
$sql_chunks['join'][] = $clause_sql['join'];
1316
// Filter to remove empties.
1317
$sql_chunks['join'] = array_filter( $sql_chunks['join'] );
1318
$sql_chunks['where'] = array_filter( $sql_chunks['where'] );
1320
if ( empty( $relation ) ) {
1324
// Filter duplicate JOIN clauses and combine into a single string.
1325
if ( ! empty( $sql_chunks['join'] ) ) {
1326
$sql['join'] = implode( ' ', array_unique( $sql_chunks['join'] ) );
1329
// Generate a single WHERE clause with proper brackets and indentation.
1330
if ( ! empty( $sql_chunks['where'] ) ) {
1331
$sql['where'] = '( ' . "\n " . $indent . implode( ' ' . "\n " . $indent . $relation . ' ' . "\n " . $indent, $sql_chunks['where'] ) . "\n" . $indent . ')';
1338
* Generate SQL JOIN and WHERE clauses for a first-order query clause.
1340
* "First-order" means that it's an array with a 'key' or 'value'.
1345
* @global wpdb $wpdb
1347
* @param array $clause Query clause, passed by reference.
1348
* @param array $parent_query Parent query array.
1349
* @param string $clause_key Optional. The array key used to name the clause in the original `$meta_query`
1350
* parameters. If not provided, a key will be generated automatically.
1352
* Array containing JOIN and WHERE SQL clauses to append to a first-order query.
1354
* @type string $join SQL fragment to append to the main JOIN clause.
1355
* @type string $where SQL fragment to append to the main WHERE clause.
1358
public function get_sql_for_clause( &$clause, $parent_query, $clause_key = '' ) {
1361
$sql_chunks = array(
1366
if ( isset( $clause['compare'] ) ) {
1367
$clause['compare'] = strtoupper( $clause['compare'] );
1369
$clause['compare'] = isset( $clause['value'] ) && is_array( $clause['value'] ) ? 'IN' : '=';
1372
if ( ! in_array( $clause['compare'], array(
1373
'=', '!=', '>', '>=', '<', '<=',
1376
'BETWEEN', 'NOT BETWEEN',
1377
'EXISTS', 'NOT EXISTS',
1378
'REGEXP', 'NOT REGEXP', 'RLIKE'
1380
$clause['compare'] = '=';
1383
$meta_compare = $clause['compare'];
1385
// First build the JOIN clause, if one is required.
1388
// We prefer to avoid joins if possible. Look for an existing join compatible with this clause.
1389
$alias = $this->find_compatible_table_alias( $clause, $parent_query );
1390
if ( false === $alias ) {
1391
$i = count( $this->table_aliases );
1392
$alias = $i ? 'mt' . $i : $this->meta_table;
1394
// JOIN clauses for NOT EXISTS have their own syntax.
1395
if ( 'NOT EXISTS' === $meta_compare ) {
1396
$join .= " LEFT JOIN $this->meta_table";
1397
$join .= $i ? " AS $alias" : '';
1398
$join .= $wpdb->prepare( " ON ($this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column AND $alias.meta_key = %s )", $clause['key'] );
1400
// All other JOIN clauses.
1402
$join .= " INNER JOIN $this->meta_table";
1403
$join .= $i ? " AS $alias" : '';
1404
$join .= " ON ( $this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column )";
1407
$this->table_aliases[] = $alias;
1408
$sql_chunks['join'][] = $join;
1411
// Save the alias to this clause, for future siblings to find.
1412
$clause['alias'] = $alias;
1414
// Determine the data type.
1415
$_meta_type = isset( $clause['type'] ) ? $clause['type'] : '';
1416
$meta_type = $this->get_cast_for_type( $_meta_type );
1417
$clause['cast'] = $meta_type;
1419
// Fallback for clause keys is the table alias.
1420
if ( ! $clause_key ) {
1421
$clause_key = $clause['alias'];
1424
// Ensure unique clause keys, so none are overwritten.
1426
$clause_key_base = $clause_key;
1427
while ( isset( $this->clauses[ $clause_key ] ) ) {
1428
$clause_key = $clause_key_base . '-' . $iterator;
1432
// Store the clause in our flat array.
1433
$this->clauses[ $clause_key ] =& $clause;
1435
// Next, build the WHERE clause.
1438
if ( array_key_exists( 'key', $clause ) ) {
1439
if ( 'NOT EXISTS' === $meta_compare ) {
1440
$sql_chunks['where'][] = $alias . '.' . $this->meta_id_column . ' IS NULL';
1442
$sql_chunks['where'][] = $wpdb->prepare( "$alias.meta_key = %s", trim( $clause['key'] ) );
1447
if ( array_key_exists( 'value', $clause ) ) {
1448
$meta_value = $clause['value'];
1450
if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
1451
if ( ! is_array( $meta_value ) ) {
1452
$meta_value = preg_split( '/[,\s]+/', $meta_value );
1455
$meta_value = trim( $meta_value );
1458
switch ( $meta_compare ) {
1461
$meta_compare_string = '(' . substr( str_repeat( ',%s', count( $meta_value ) ), 1 ) . ')';
1462
$where = $wpdb->prepare( $meta_compare_string, $meta_value );
1466
case 'NOT BETWEEN' :
1467
$meta_value = array_slice( $meta_value, 0, 2 );
1468
$where = $wpdb->prepare( '%s AND %s', $meta_value );
1473
$meta_value = '%' . $wpdb->esc_like( $meta_value ) . '%';
1474
$where = $wpdb->prepare( '%s', $meta_value );
1477
// EXISTS with a value is interpreted as '='.
1479
$meta_compare = '=';
1480
$where = $wpdb->prepare( '%s', $meta_value );
1483
// 'value' is ignored for NOT EXISTS.
1489
$where = $wpdb->prepare( '%s', $meta_value );
1495
$sql_chunks['where'][] = "CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$where}";
1500
* Multiple WHERE clauses (for meta_key and meta_value) should
1501
* be joined in parentheses.
1503
if ( 1 < count( $sql_chunks['where'] ) ) {
1504
$sql_chunks['where'] = array( '( ' . implode( ' AND ', $sql_chunks['where'] ) . ' )' );
1511
* Get a flattened list of sanitized meta clauses.
1513
* This array should be used for clause lookup, as when the table alias and CAST type must be determined for
1514
* a value of 'orderby' corresponding to a meta clause.
1519
* @return array Meta clauses.
1521
public function get_clauses() {
1522
return $this->clauses;
1526
* Identify an existing table alias that is compatible with the current
1529
* We avoid unnecessary table joins by allowing each clause to look for
1530
* an existing table alias that is compatible with the query that it
1533
* An existing alias is compatible if (a) it is a sibling of `$clause`
1534
* (ie, it's under the scope of the same relation), and (b) the combination
1535
* of operator and relation between the clauses allows for a shared table join.
1536
* In the case of {@see WP_Meta_Query}, this only applies to 'IN' clauses that
1537
* are connected by the relation 'OR'.
1542
* @param array $clause Query clause.
1543
* @param array $parent_query Parent query of $clause.
1544
* @return string|bool Table alias if found, otherwise false.
1546
protected function find_compatible_table_alias( $clause, $parent_query ) {
1549
foreach ( $parent_query as $sibling ) {
1550
// If the sibling has no alias yet, there's nothing to check.
1551
if ( empty( $sibling['alias'] ) ) {
1555
// We're only interested in siblings that are first-order clauses.
1556
if ( ! is_array( $sibling ) || ! $this->is_first_order_clause( $sibling ) ) {
1560
$compatible_compares = array();
1562
// Clauses connected by OR can share joins as long as they have "positive" operators.
1563
if ( 'OR' === $parent_query['relation'] ) {
1564
$compatible_compares = array( '=', 'IN', 'BETWEEN', 'LIKE', 'REGEXP', 'RLIKE', '>', '>=', '<', '<=' );
1566
// Clauses joined by AND with "negative" operators share a join only if they also share a key.
1567
} elseif ( isset( $sibling['key'] ) && isset( $clause['key'] ) && $sibling['key'] === $clause['key'] ) {
1568
$compatible_compares = array( '!=', 'NOT IN', 'NOT LIKE' );
1571
$clause_compare = strtoupper( $clause['compare'] );
1572
$sibling_compare = strtoupper( $sibling['compare'] );
1573
if ( in_array( $clause_compare, $compatible_compares ) && in_array( $sibling_compare, $compatible_compares ) ) {
1574
$alias = $sibling['alias'];
1580
* Filter the table alias identified as compatible with the current clause.
1584
* @param string|bool $alias Table alias, or false if none was found.
1585
* @param array $clause First-order query clause.
1586
* @param array $parent_query Parent of $clause.
1587
* @param object $this WP_Meta_Query object.
1589
return apply_filters( 'meta_query_find_compatible_table_alias', $alias, $clause, $parent_query, $this ) ;
1593
* Checks whether the current query has any OR relations.
1595
* In some cases, the presence of an OR relation somewhere in the query will require
1596
* the use of a `DISTINCT` or `GROUP BY` keyword in the `SELECT` clause. The current
1597
* method can be used in these cases to determine whether such a clause is necessary.
1601
* @return bool True if the query contains any `OR` relations, otherwise false.
1603
public function has_or_relation() {
1604
return $this->has_or_relation;
1609
871
* Retrieve the name of the metadata table for the specified object type.
added
removed
wp-includes/meta.php
