<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[17699] trunk/wp-includes: Introduce WP_Meta_Query and relation support.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/17699">17699</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2011-04-25 17:27:35 +0000 (Mon, 25 Apr 2011)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce WP_Meta_Query and relation support. Props scribu, greuben. fixes <a href="http://trac.wordpress.org/ticket/17165">#17165</a> <a href="http://trac.wordpress.org/ticket/17011">#17011</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesmetaphp">trunk/wp-includes/meta.php</a></li>
<li><a href="#trunkwpincludesqueryphp">trunk/wp-includes/query.php</a></li>
<li><a href="#trunkwpincludesuserphp">trunk/wp-includes/user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesmetaphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/meta.php (17698 => 17699)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/meta.php 2011-04-25 14:33:27 UTC (rev 17698)
+++ trunk/wp-includes/meta.php 2011-04-25 17:27:35 UTC (rev 17699)
</span><span class="lines">@@ -355,121 +355,190 @@
</span><span class="cx"> /**
</span><span class="cx"> * Given a meta query, generates SQL clauses to be appended to a main query
</span><span class="cx"> *
</span><del>- * @since 3.1.0
- * @access private
</del><ins>+ * @since 3.2.0
</ins><span class="cx"> *
</span><del>- * @param array $meta_query List of metadata queries. A single query is an associative array:
- * - 'key' string The meta key
- * - 'value' string|array The meta value
- * - 'compare' (optional) string How to compare the key to the value.
- * Possible values: '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'.
- * Default: '='
- * - 'type' string (optional) The type of the value.
- * Possible values: 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'.
- * Default: 'CHAR'
</del><ins>+ * @see WP_Meta_Query
</ins><span class="cx"> *
</span><ins>+ * @param array (optional) $meta_query A meta query
</ins><span class="cx"> * @param string $type Type of meta
</span><span class="cx"> * @param string $primary_table
</span><span class="cx"> * @param string $primary_id_column
</span><span class="cx"> * @param object $context (optional) The main query object
</span><span class="cx"> * @return array( 'join' => $join_sql, 'where' => $where_sql )
</span><span class="cx"> */
</span><del>-function _get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null ) {
- global $wpdb;
</del><ins>+function get_meta_sql( $meta_query = false, $type, $primary_table, $primary_id_column, $context = null ) {
+ $meta_query_obj = new WP_Meta_Query( $meta_query );
+ return $meta_query_obj->get_sql( $type, $primary_table, $primary_id_column, $context );
+}
</ins><span class="cx">
</span><del>- if ( ! $meta_table = _get_meta_table( $type ) )
- return false;
</del><ins>+/**
+ * Container class for a multiple metadata query
+ *
+ * @since 3.2
+ */
+class WP_Meta_Query {
+ /**
+ * List of metadata queries. A single query is an associative array:
+ * - 'key' string The meta key
+ * - 'value' string|array The meta value
+ * - 'compare' (optional) string How to compare the key to the value.
+ * Possible values: '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'.
+ * Default: '='
+ * - 'type' string (optional) The type of the value.
+ * Possible values: 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'.
+ * Default: 'CHAR'
+ *
+ * @since 3.2
+ * @access public
+ * @var array
+ */
+ public $queries = array();
</ins><span class="cx">
</span><del>- $meta_id_column = esc_sql( $type . '_id' );
</del><ins>+ /**
+ * The relation between the queries. Can be one of 'AND' or 'OR'.
+ *
+ * @since 3.2
+ * @access public
+ * @var string
+ */
+ public $relation;
</ins><span class="cx">
</span><del>- $join = '';
- $where = '';
- $i = 0;
- foreach ( $meta_query as $q ) {
- $meta_key = isset( $q['key'] ) ? trim( $q['key'] ) : '';
- $meta_compare = isset( $q['compare'] ) ? strtoupper( $q['compare'] ) : '=';
- $meta_type = isset( $q['type'] ) ? strtoupper( $q['type'] ) : 'CHAR';
</del><ins>+ /**
+ * Constructor
+ *
+ * @param array (optional) $meta_query A meta query
+ */
+ function __construct( $meta_query = false ) {
+ if ( !$meta_query )
+ return;
</ins><span class="cx">
</span><del>- if ( ! in_array( $meta_compare, array( '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) )
- $meta_compare = '=';
</del><ins>+ if ( isset( $meta_query['relation'] ) && strtoupper( $meta_query['relation'] ) == 'OR' ) {
+ $this->relation = 'OR';
+ } else {
+ $this->relation = 'AND';
+ }
</ins><span class="cx">
</span><del>- if ( 'NUMERIC' == $meta_type )
- $meta_type = 'SIGNED';
- elseif ( ! in_array( $meta_type, array( 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED' ) ) )
- $meta_type = 'CHAR';
</del><ins>+ $this->queries = array();
</ins><span class="cx">
</span><del>- if ( empty( $meta_key ) && empty( $meta_value ) )
- continue;
</del><ins>+ foreach ( $meta_query as $key => $query ) {
+ if ( ! is_array( $query ) )
+ continue;
</ins><span class="cx">
</span><del>- $alias = $i ? 'mt' . $i : $meta_table;
</del><ins>+ $this->queries[] = $query;
+ }
+ }
</ins><span class="cx">
</span><del>- $join .= "\nINNER JOIN $meta_table";
- $join .= $i ? " AS $alias" : '';
- $join .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column)";
</del><ins>+ /**
+ * Constructs a meta query based on 'meta_*' query vars
+ *
+ * @since 3.2
+ * @access public
+ *
+ * @param array $qv The query variables
+ */
+ function parse_query_vars( $qv ) {
+ $meta_query = array();
</ins><span class="cx">
</span><del>- $i++;
</del><ins>+ // Simple query needs to be first for orderby=meta_value to work correctly
+ foreach ( array( 'key', 'compare', 'type' ) as $key ) {
+ if ( !empty( $qv[ "meta_$key" ] ) )
+ $meta_query[0][ $key ] = $qv[ "meta_$key" ];
+ }
</ins><span class="cx">
</span><del>- if ( !empty( $meta_key ) )
- $where .= $wpdb->prepare( " AND $alias.meta_key = %s", $meta_key );
</del><ins>+ // WP_Query sets 'meta_value' = '' by default
+ if ( isset( $qv[ 'meta_value' ] ) && '' !== $qv[ 'meta_value' ] )
+ $meta_query[0]['value'] = $qv[ 'meta_value' ];
</ins><span class="cx">
</span><del>- if ( !isset( $q['value'] ) )
- continue;
- $meta_value = $q['value'];
</del><ins>+ if ( !empty( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ) {
+ $meta_query = array_merge( $meta_query, $qv['meta_query'] );
+ }
</ins><span class="cx">
</span><del>- if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
- if ( ! is_array( $meta_value ) )
- $meta_value = preg_split( '/[,\s]+/', $meta_value );
</del><ins>+ $this->__construct( $meta_query );
+ }
</ins><span class="cx">
</span><del>- if ( empty( $meta_value ) )
</del><ins>+ /**
+ * Generates SQL clauses to be appended to a main query.
+ *
+ * @since 3.2
+ * @access public
+ *
+ * @param string $type Type of meta
+ * @param string $primary_table
+ * @param string $primary_id_column
+ * @param object $context (optional) The main query object
+ * @return array( 'join' => $join_sql, 'where' => $where_sql )
+ */
+ function get_sql( $type, $primary_table, $primary_id_column, $context = null ) {
+ global $wpdb;
+
+ if ( ! $meta_table = _get_meta_table( $type ) )
+ return false;
+
+ $meta_id_column = esc_sql( $type . '_id' );
+
+ $join = '';
+ $where = array();
+ $i = 0;
+ foreach ( $this->queries as $k => $q ) {
+ $meta_key = isset( $q['key'] ) ? trim( $q['key'] ) : '';
+ $meta_compare = isset( $q['compare'] ) ? strtoupper( $q['compare'] ) : '=';
+ $meta_type = isset( $q['type'] ) ? strtoupper( $q['type'] ) : 'CHAR';
+
+ if ( ! in_array( $meta_compare, array( '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) )
+ $meta_compare = '=';
+
+ if ( 'NUMERIC' == $meta_type )
+ $meta_type = 'SIGNED';
+ elseif ( ! in_array( $meta_type, array( 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED' ) ) )
+ $meta_type = 'CHAR';
+
+ if ( empty( $meta_key ) && empty( $meta_value ) )
</ins><span class="cx"> continue;
</span><del>- } else {
- $meta_value = trim( $meta_value );
- }
</del><span class="cx">
</span><del>- if ( 'IN' == substr( $meta_compare, -2) ) {
- $meta_compare_string = '(' . substr( str_repeat( ',%s', count( $meta_value ) ), 1 ) . ')';
- } elseif ( 'BETWEEN' == substr( $meta_compare, -7) ) {
- $meta_value = array_slice( $meta_value, 0, 2 );
- $meta_compare_string = '%s AND %s';
- } elseif ( 'LIKE' == substr( $meta_compare, -4 ) ) {
- $meta_value = '%' . like_escape( $meta_value ) . '%';
- $meta_compare_string = '%s';
- } else {
- $meta_compare_string = '%s';
- }
</del><ins>+ $alias = $i ? 'mt' . $i : $meta_table;
</ins><span class="cx">
</span><del>- $where .= $wpdb->prepare( " AND CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$meta_compare_string}", $meta_value );
- }
</del><ins>+ $join .= "\nINNER JOIN $meta_table";
+ $join .= $i ? " AS $alias" : '';
+ $join .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column)";
</ins><span class="cx">
</span><del>- return apply_filters_ref_array( 'get_meta_sql', array( compact( 'join', 'where' ), $meta_query, $type, $primary_table, $primary_id_column, &$context ) );
-}
</del><ins>+ $i++;
</ins><span class="cx">
</span><del>-/**
- * Populates the $meta_query property
- *
- * @access private
- * @since 3.1.0
- *
- * @param array $qv The query variables
- */
-function _parse_meta_query( &$qv ) {
- $meta_query = array();
</del><ins>+ if ( !empty( $meta_key ) )
+ $where[$k] = $wpdb->prepare( "$alias.meta_key = %s", $meta_key );
</ins><span class="cx">
</span><del>- // Simple query needs to be first for orderby=meta_value to work correctly
- foreach ( array( 'key', 'compare', 'type' ) as $key ) {
- if ( !empty( $qv[ "meta_$key" ] ) )
- $meta_query[0][ $key ] = $qv[ "meta_$key" ];
- }
</del><ins>+ if ( !isset( $q['value'] ) )
+ continue;
+ $meta_value = $q['value'];
</ins><span class="cx">
</span><del>- // WP_Query sets 'meta_value' = '' by default
- if ( isset( $qv[ 'meta_value' ] ) && '' !== $qv[ 'meta_value' ] )
- $meta_query[0]['value'] = $qv[ 'meta_value' ];
</del><ins>+ if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
+ if ( ! is_array( $meta_value ) )
+ $meta_value = preg_split( '/[,\s]+/', $meta_value );
</ins><span class="cx">
</span><del>- if ( !empty( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ) {
- $meta_query = array_merge( $meta_query, $qv['meta_query'] );
</del><ins>+ if ( empty( $meta_value ) )
+ continue;
+ } else {
+ $meta_value = trim( $meta_value );
+ }
+
+ if ( 'IN' == substr( $meta_compare, -2) ) {
+ $meta_compare_string = '(' . substr( str_repeat( ',%s', count( $meta_value ) ), 1 ) . ')';
+ } elseif ( 'BETWEEN' == substr( $meta_compare, -7) ) {
+ $meta_value = array_slice( $meta_value, 0, 2 );
+ $meta_compare_string = '%s AND %s';
+ } elseif ( 'LIKE' == substr( $meta_compare, -4 ) ) {
+ $meta_value = '%' . like_escape( $meta_value ) . '%';
+ $meta_compare_string = '%s';
+ } else {
+ $meta_compare_string = '%s';
+ }
+
+ $where[$k] = ' (' . $where[$k] . $wpdb->prepare( " AND CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$meta_compare_string})", $meta_value );
+ }
+ $where = ' AND (' . implode( " {$this->relation} ", $where ) . ' )';
+
+ return apply_filters_ref_array( 'get_meta_sql', array( compact( 'join', 'where' ), $this->queries, $type, $primary_table, $primary_id_column, $context ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- $qv['meta_query'] = $meta_query;
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkwpincludesqueryphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/query.php (17698 => 17699)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/query.php 2011-04-25 14:33:27 UTC (rev 17698)
+++ trunk/wp-includes/query.php 2011-04-25 17:27:35 UTC (rev 17699)
</span><span class="lines">@@ -849,6 +849,15 @@
</span><span class="cx"> var $tax_query;
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Metadata query container
+ *
+ * @since 3.2
+ * @access public
+ * @var object WP_Meta_Query
+ */
+ var $meta_query = false;
+
+ /**
</ins><span class="cx"> * Holds the data for a single object that is queried.
</span><span class="cx"> *
</span><span class="cx"> * Holds the contents of a post, page, category, attachment.
</span><span class="lines">@@ -1525,8 +1534,6 @@
</span><span class="cx"> }
</span><span class="cx"> unset( $tax_query );
</span><span class="cx">
</span><del>- _parse_meta_query( $qv );
-
</del><span class="cx"> if ( empty($qv['author']) || ($qv['author'] == '0') ) {
</span><span class="cx"> $this->is_author = false;
</span><span class="cx"> } else {
</span><span class="lines">@@ -1900,6 +1907,10 @@
</span><span class="cx"> // Fill again in case pre_get_posts unset some vars.
</span><span class="cx"> $q = $this->fill_query_vars($q);
</span><span class="cx">
</span><ins>+ // Parse meta query
+ $this->meta_query = new WP_Meta_Query();
+ $this->meta_query->parse_query_vars( $q );
+
</ins><span class="cx"> // Set a flag if a pre_get_posts hook changed the query vars.
</span><span class="cx"> $hash = md5( serialize( $this->query_vars ) );
</span><span class="cx"> if ( $hash != $this->query_vars_hash ) {
</span><span class="lines">@@ -2235,7 +2246,7 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( !empty( $this->tax_query->queries ) || !empty( $q['meta_key'] ) ) {
</del><ins>+ if ( !empty( $this->tax_query->queries ) || !empty( $this->meta_query->queries ) ) {
</ins><span class="cx"> $groupby = "{$wpdb->posts}.ID";
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2468,18 +2479,8 @@
</span><span class="cx"> $where .= ')';
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Parse the meta query again if query vars have changed.
- if ( $this->query_vars_changed ) {
- $meta_query_hash = md5( serialize( $q['meta_query'] ) );
- $_meta_query = $q['meta_query'];
- unset( $q['meta_query'] );
- _parse_meta_query( $q );
- if ( md5( serialize( $q['meta_query'] ) ) != $meta_query_hash && is_array( $_meta_query ) )
- $q['meta_query'] = array_merge( $_meta_query, $q['meta_query'] );
- }
-
- if ( !empty( $q['meta_query'] ) ) {
- $clauses = call_user_func_array( '_get_meta_sql', array( $q['meta_query'], 'post', $wpdb->posts, 'ID', &$this) );
</del><ins>+ if ( !empty( $this->meta_query->queries ) ) {
+ $clauses = $this->meta_query->get_sql( 'post', $wpdb->posts, 'ID', $this );
</ins><span class="cx"> $join .= $clauses['join'];
</span><span class="cx"> $where .= $clauses['where'];
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkwpincludesuserphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/user.php (17698 => 17699)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/user.php 2011-04-25 14:33:27 UTC (rev 17698)
+++ trunk/wp-includes/user.php 2011-04-25 17:27:35 UTC (rev 17699)
</span><span class="lines">@@ -501,8 +501,6 @@
</span><span class="cx"> $qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
</span><span class="cx"> }
</span><span class="cx">
</span><del>- _parse_meta_query( $qv );
-
</del><span class="cx"> $role = trim( $qv['role'] );
</span><span class="cx">
</span><span class="cx"> if ( $blog_id && ( $role || is_multisite() ) ) {
</span><span class="lines">@@ -517,8 +515,11 @@
</span><span class="cx"> $qv['meta_query'][] = $cap_meta_query;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( !empty( $qv['meta_query'] ) ) {
- $clauses = call_user_func_array( '_get_meta_sql', array( $qv['meta_query'], 'user', $wpdb->users, 'ID', &$this ) );
</del><ins>+ $meta_query = new WP_Meta_Query();
+ $meta_query->parse_query_vars( $qv );
+
+ if ( !empty( $meta_query->queries ) ) {
+ $clauses = $meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
</ins><span class="cx"> $this->query_from .= $clauses['join'];
</span><span class="cx"> $this->query_where .= $clauses['where'];
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>