Changeset 31340 for trunk/src/wp-includes/meta.php

Timestamp:

02/05/2015 07:37:47 PM (10 years ago)

Author:

boonebgorges

Message:

Modify `meta_query orderby syntax to use array keys as clause "handles".

The implementation of meta_query orderby introduced in [31312] put clause
identifiers into a 'name' parameter of the clause. For greater clarity, this
changeset updates the syntax to use the associative array key used when
defining meta_query parameters, instead of the 'name' parameter.

Props Funkatronic, DrewAPicture.
Fixes #31045.

File:

• trunk/src/wp-includes/meta.php (modified) (9 diffs)

trunk/src/wp-includes/meta.php

@@ -946 +946 @@
      *
      * @since 3.2.0
-     * @since 4.2.0 Introduced the `$name` parameter, for improved `$orderby` support in the parent query.
+     * @since 4.2.0 Introduced support for naming query clauses by associative array keys.
      *
      * @access public
      *
      * @param array $meta_query {
-     *     Array of meta query clauses.
+     *     Array of meta query clauses. When first-order clauses use strings as their array keys, they may be
+     *     referenced in the 'orderby' parameter of the parent query.
      *
      *     @type string $relation Optional. The MySQL keyword used to join
@@ -968 +969 @@
      *                               'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', or 'UNSIGNED'.
      *                               Default is 'CHAR'.
-     *         @type string $name    Optional. A unique identifier for the clause. If provided, `$name` can be
-     *                               referenced in the `$orderby` parameter of the parent query.
      *     }
      * }
@@ -1017 +1016 @@
                 }
 
-                $clean_queries[] = $query;
+                $clean_queries[ $key ] = $query;
 
             // Otherwise, it's a nested query, so we recurse.
@@ -1024 +1023 @@
 
                 if ( ! empty( $cleaned_query ) ) {
-                    $clean_queries[] = $cleaned_query;
+                    $clean_queries[ $key ] = $cleaned_query;
                 }
             }
@@ -1271 +1270 @@
                 // This is a first-order clause.
                 if ( $this->is_first_order_clause( $clause ) ) {
-                    $clause_sql = $this->get_sql_for_clause( $clause, $query );
+                    $clause_sql = $this->get_sql_for_clause( $clause, $query, $key );
 
                     $where_count = count( $clause_sql['where'] );
@@ -1322 +1321 @@
      * @access public
      *
-     * @param array $clause       Query clause, passed by reference.
-     * @param array $parent_query Parent query array.
+     * @param array  $clause       Query clause, passed by reference.
+     * @param array  $parent_query Parent query array.
+     * @param string $clause_key   Optional. The array key used to name the clause in the original `$meta_query`
+     *                             parameters. If not provided, a key will be generated automatically.
      * @return array {
      *     Array containing JOIN and WHERE SQL clauses to append to a first-order query.
@@ -1331 +1332 @@
      * }
      */
-    public function get_sql_for_clause( &$clause, $parent_query ) {
+    public function get_sql_for_clause( &$clause, $parent_query, $clause_key = '' ) {
         global $wpdb;
 
@@ -1392 +1393 @@
         $clause['cast'] = $meta_type;
 
+        // Fallback for clause keys is the table alias.
+        if ( ! $clause_key ) {
+            $clause_key = $clause['alias'];
+        }
+
+        // Ensure unique clause keys, so none are overwritten.
+        $iterator = 1;
+        $clause_key_base = $clause_key;
+        while ( isset( $this->clauses[ $clause_key ] ) ) {
+            $clause_key = $clause_key_base . '-' . $iterator;
+            $iterator++;
+        }
+
         // Store the clause in our flat array.
-        $clause_name = isset( $clause['name'] ) ? $clause['name'] : $clause['alias'];
-        $this->clauses[ $clause_name ] =& $clause;
+        $this->clauses[ $clause_key ] =& $clause;
 
         // Next, build the WHERE clause.
@@ -1472 +1485 @@
 
     /**
-     * Get a flattened list of sanitized meta clauses, indexed by clause 'name'.
+     * Get a flattened list of sanitized meta clauses.
      *
      * This array should be used for clause lookup, as when the table alias and CAST type must be determined for