Changeset 31669

Timestamp:

03/07/2015 06:37:05 PM (12 years ago)

Author:

boonebgorges

Message:

Improved 'orderby' meta syntax in WP_User_Query.

Recent commits have added the ability to order query results by specific
clauses of the 'meta_query' parameter (comments [31467], posts [31312] and
[31340]). The current changeset ports the same functionality to WP_User_Query.

Also introduced is the ability to pass the value of $meta_key to 'orderby'.

The internals of WP_User_Query::prepare_users() had to be reordered
somewhat to support these changes, primarily to ensure that the meta_query
object generates its SQL clauses before the 'orderby' parameter is parsed.

See #31265.

Location:

trunk

Files:

• src/wp-includes/user.php (modified) (8 diffs)
• tests/phpunit/tests/user/query.php (modified) (1 diff)

trunk/src/wp-includes/user.php

@@ -532 +532 @@
          *     @type array        $search_columns  Array of column names to be searched. Accepts 'ID', 'login',
          *                                         'nicename', 'email', 'url'. Default empty array.
-         *     @type string|array $orderby         Field to sort the retrieved users by. May be a single value,
+         *     @type string|array $orderby         Field(s) to sort the retrieved users by. May be a single value,
          *                                         an array of values, or a multi-dimensional array with fields as keys
          *                                         and orders ('ASC' or 'DESC') as values. Accepted values are'ID',
@@ -538 +538 @@
          *                                         'user_nicename' (or 'nicename'), 'user_email' (or 'email'),
          *                                         'user_url' (or 'url'), 'user_registered' (or 'registered'),
-         *                                         'post_count', 'meta_value', or 'meta_value_num'. To use 'meta_value'
+         *                                         'post_count', 'meta_value', 'meta_value_num', the value of
+         *                                         `$meta_key`, or an array key of `$meta_query`. To use 'meta_value'
          *                                         or 'meta_value_num', `$meta_key` must be also be defined.
          *                                         Default 'user_login'.
@@ -626 +627 @@
                 }
 
+                // Meta query.
+                $this->meta_query = new WP_Meta_Query();
+                $this->meta_query->parse_query_vars( $qv );
+
+                $blog_id = 0;
+                if ( isset( $qv['blog_id'] ) ) {
+                        $blog_id = absint( $qv['blog_id'] );
+                }
+
+                $role = '';
+                if ( isset( $qv['role'] ) ) {
+                        $role = trim( $qv['role'] );
+                }
+
+                if ( $blog_id && ( $role || is_multisite() ) ) {
+                        $cap_meta_query = array();
+                        $cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
+
+                        if ( $role ) {
+                                $cap_meta_query['value'] = '"' . $role . '"';
+                                $cap_meta_query['compare'] = 'like';
+                        }
+
+                        if ( empty( $this->meta_query->queries ) ) {
+                                $this->meta_query->queries = array( $cap_meta_query );
+                        } elseif ( ! in_array( $cap_meta_query, $this->meta_query->queries, true ) ) {
+                                // Append the cap query to the original queries and reparse the query.
+                                $this->meta_query->queries = array(
+                                        'relation' => 'AND',
+                                        array( $this->meta_query->queries, $cap_meta_query ),
+                                );
+                        }
+
+                        $this->meta_query->parse_query_vars( $this->meta_query->queries );
+                }
+
+                if ( ! empty( $this->meta_query->queries ) ) {
+                        $clauses = $this->meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
+                        $this->query_from .= $clauses['join'];
+                        $this->query_where .= $clauses['where'];
+
+                        if ( 'OR' == $this->meta_query->relation ) {
+                                $this->query_fields = 'DISTINCT ' . $this->query_fields;
+                        }
+                }
+
                 // sorting
                 $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
@@ -729 +776 @@
                 }
 
-                $blog_id = 0;
-                if ( isset( $qv['blog_id'] ) )
-                        $blog_id = absint( $qv['blog_id'] );
-
                 if ( isset( $qv['who'] ) && 'authors' == $qv['who'] && $blog_id ) {
                         $qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level';
@@ -738 +781 @@
                         $qv['meta_compare'] = '!=';
                         $qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
-                }
-
-                $this->meta_query = new WP_Meta_Query();
-                $this->meta_query->parse_query_vars( $qv );
-
-                $role = '';
-                if ( isset( $qv['role'] ) )
-                        $role = trim( $qv['role'] );
-
-                if ( $blog_id && ( $role || is_multisite() ) ) {
-                        $cap_meta_query = array();
-                        $cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
-
-                        if ( $role ) {
-                                $cap_meta_query['value'] = '"' . $role . '"';
-                                $cap_meta_query['compare'] = 'like';
-                        }
-
-                        if ( empty( $this->meta_query->queries ) ) {
-                                $this->meta_query->queries = array( $cap_meta_query );
-                        } elseif ( ! in_array( $cap_meta_query, $this->meta_query->queries, true ) ) {
-                                // Append the cap query to the original queries and reparse the query.
-                                $this->meta_query->queries = array(
-                                        'relation' => 'AND',
-                                        array( $this->meta_query->queries, $cap_meta_query ),
-                                );
-                        }
-
-                        $this->meta_query->parse_query_vars( $this->meta_query->queries );
-                }
-
-                if ( !empty( $this->meta_query->queries ) ) {
-                        $clauses = $this->meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
-                        $this->query_from .= $clauses['join'];
-                        $this->query_where .= $clauses['where'];
-
-                        if ( 'OR' == $this->meta_query->relation )
-                                $this->query_fields = 'DISTINCT ' . $this->query_fields;
                 }
 
@@ -955 +960 @@
         protected function parse_orderby( $orderby ) {
                 global $wpdb;
+
+                $meta_query_clauses = $this->meta_query->get_clauses();
 
                 $_orderby = '';
@@ -976 +983 @@
                 } elseif ( 'ID' == $orderby || 'id' == $orderby ) {
                         $_orderby = 'ID';
-                } elseif ( 'meta_value' == $orderby ) {
+                } elseif ( 'meta_value' == $orderby || $this->get( 'meta_key' ) == $orderby ) {
                         $_orderby = "$wpdb->usermeta.meta_value";
                 } elseif ( 'meta_value_num' == $orderby ) {
@@ -984 +991 @@
                         $include_sql = implode( ',', $include );
                         $_orderby = "FIELD( $wpdb->users.ID, $include_sql )";
+                } elseif ( isset( $meta_query_clauses[ $orderby ] ) ) {
+                        $meta_clause = $meta_query_clauses[ $orderby ];
+                        $_orderby = sprintf( "CAST(%s.meta_value AS %s)", esc_sql( $meta_clause['alias'] ), esc_sql( $meta_clause['cast'] ) );
                 }
 

trunk/tests/phpunit/tests/user/query.php

@@ -178 +178 @@
 
                 $this->assertEquals( $expected, $q->get_results() );
+        }
+
+        /**
+         * @ticket 31265
+         */
+        public function test_orderby_somekey_where_meta_key_is_somekey() {
+                $users = $this->factory->user->create_many( 3, array(
+                        'role' => 'author'
+                ) );
+
+                update_user_meta( $users[0], 'foo', 'zzz' );
+                update_user_meta( $users[1], 'foo', 'aaa' );
+                update_user_meta( $users[2], 'foo', 'jjj' );
+
+                $q = new WP_User_Query( array(
+                        'include' => $users,
+                        'meta_key' => 'foo',
+                        'orderby' => 'foo',
+                        'fields' => 'ids'
+                ) );
+
+                $expected = array( $users[1], $users[2], $users[0] );
+
+                $this->assertEquals( $expected, $q->get_results() );
+        }
+
+        /**
+         * @ticket 31265
+         */
+        public function test_orderby_clause_key() {
+                $users = $this->factory->user->create_many( 3 );
+                add_user_meta( $users[0], 'foo', 'aaa' );
+                add_user_meta( $users[1], 'foo', 'zzz' );
+                add_user_meta( $users[2], 'foo', 'jjj' );
+
+                $q = new WP_User_Query( array(
+                        'fields' => 'ids',
+                        'meta_query' => array(
+                                'foo_key' => array(
+                                        'key' => 'foo',
+                                        'compare' => 'EXISTS',
+                                ),
+                        ),
+                        'orderby' => 'foo_key',
+                        'order' => 'DESC',
+                ) );
+
+                $this->assertEquals( array( $users[1], $users[2], $users[0] ), $q->results );
+        }
+
+        /**
+         * @ticket 31265
+         */
+        public function test_orderby_clause_key_as_secondary_sort() {
+                $u1 = $this->factory->user->create( array(
+                        'user_registered' => '2015-01-28 03:00:00',
+                ) );
+                $u2 = $this->factory->user->create( array(
+                        'user_registered' => '2015-01-28 05:00:00',
+                ) );
+                $u3 = $this->factory->user->create( array(
+                        'user_registered' => '2015-01-28 03:00:00',
+                ) );
+
+                add_user_meta( $u1, 'foo', 'jjj' );
+                add_user_meta( $u2, 'foo', 'zzz' );
+                add_user_meta( $u3, 'foo', 'aaa' );
+
+                $q = new WP_User_Query( array(
+                        'fields' => 'ids',
+                        'meta_query' => array(
+                                'foo_key' => array(
+                                        'key' => 'foo',
+                                        'compare' => 'EXISTS',
+                                ),
+                        ),
+                        'orderby' => array(
+                                'comment_date' => 'asc',
+                                'foo_key' => 'asc',
+                        ),
+                ) );
+
+                $this->assertEquals( array( $u3, $u1, $u2 ), $q->results );
+        }
+
+        /**
+         * @ticket 31265
+         */
+        public function test_orderby_more_than_one_clause_key() {
+                $users = $this->factory->user->create_many( 3 );
+
+                add_user_meta( $users[0], 'foo', 'jjj' );
+                add_user_meta( $users[1], 'foo', 'zzz' );
+                add_user_meta( $users[2], 'foo', 'jjj' );
+                add_user_meta( $users[0], 'bar', 'aaa' );
+                add_user_meta( $users[1], 'bar', 'ccc' );
+                add_user_meta( $users[2], 'bar', 'bbb' );
+
+                $q = new WP_User_Query( array(
+                        'fields' => 'ids',
+                        'meta_query' => array(
+                                'foo_key' => array(
+                                        'key' => 'foo',
+                                        'compare' => 'EXISTS',
+                                ),
+                                'bar_key' => array(
+                                        'key' => 'bar',
+                                        'compare' => 'EXISTS',
+                                ),
+                        ),
+                        'orderby' => array(
+                                'foo_key' => 'asc',
+                                'bar_key' => 'desc',
+                        ),
+                ) );
+
+                $this->assertEquals( array( $users[2], $users[0], $users[1] ), $q->results );
         }