Make WordPress Core


Ignore:
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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/tests/user/query.php

    r31668 r31669  
    178178
    179179                $this->assertEquals( $expected, $q->get_results() );
     180        }
     181
     182        /**
     183         * @ticket 31265
     184         */
     185        public function test_orderby_somekey_where_meta_key_is_somekey() {
     186                $users = $this->factory->user->create_many( 3, array(
     187                        'role' => 'author'
     188                ) );
     189
     190                update_user_meta( $users[0], 'foo', 'zzz' );
     191                update_user_meta( $users[1], 'foo', 'aaa' );
     192                update_user_meta( $users[2], 'foo', 'jjj' );
     193
     194                $q = new WP_User_Query( array(
     195                        'include' => $users,
     196                        'meta_key' => 'foo',
     197                        'orderby' => 'foo',
     198                        'fields' => 'ids'
     199                ) );
     200
     201                $expected = array( $users[1], $users[2], $users[0] );
     202
     203                $this->assertEquals( $expected, $q->get_results() );
     204        }
     205
     206        /**
     207         * @ticket 31265
     208         */
     209        public function test_orderby_clause_key() {
     210                $users = $this->factory->user->create_many( 3 );
     211                add_user_meta( $users[0], 'foo', 'aaa' );
     212                add_user_meta( $users[1], 'foo', 'zzz' );
     213                add_user_meta( $users[2], 'foo', 'jjj' );
     214
     215                $q = new WP_User_Query( array(
     216                        'fields' => 'ids',
     217                        'meta_query' => array(
     218                                'foo_key' => array(
     219                                        'key' => 'foo',
     220                                        'compare' => 'EXISTS',
     221                                ),
     222                        ),
     223                        'orderby' => 'foo_key',
     224                        'order' => 'DESC',
     225                ) );
     226
     227                $this->assertEquals( array( $users[1], $users[2], $users[0] ), $q->results );
     228        }
     229
     230        /**
     231         * @ticket 31265
     232         */
     233        public function test_orderby_clause_key_as_secondary_sort() {
     234                $u1 = $this->factory->user->create( array(
     235                        'user_registered' => '2015-01-28 03:00:00',
     236                ) );
     237                $u2 = $this->factory->user->create( array(
     238                        'user_registered' => '2015-01-28 05:00:00',
     239                ) );
     240                $u3 = $this->factory->user->create( array(
     241                        'user_registered' => '2015-01-28 03:00:00',
     242                ) );
     243
     244                add_user_meta( $u1, 'foo', 'jjj' );
     245                add_user_meta( $u2, 'foo', 'zzz' );
     246                add_user_meta( $u3, 'foo', 'aaa' );
     247
     248                $q = new WP_User_Query( array(
     249                        'fields' => 'ids',
     250                        'meta_query' => array(
     251                                'foo_key' => array(
     252                                        'key' => 'foo',
     253                                        'compare' => 'EXISTS',
     254                                ),
     255                        ),
     256                        'orderby' => array(
     257                                'comment_date' => 'asc',
     258                                'foo_key' => 'asc',
     259                        ),
     260                ) );
     261
     262                $this->assertEquals( array( $u3, $u1, $u2 ), $q->results );
     263        }
     264
     265        /**
     266         * @ticket 31265
     267         */
     268        public function test_orderby_more_than_one_clause_key() {
     269                $users = $this->factory->user->create_many( 3 );
     270
     271                add_user_meta( $users[0], 'foo', 'jjj' );
     272                add_user_meta( $users[1], 'foo', 'zzz' );
     273                add_user_meta( $users[2], 'foo', 'jjj' );
     274                add_user_meta( $users[0], 'bar', 'aaa' );
     275                add_user_meta( $users[1], 'bar', 'ccc' );
     276                add_user_meta( $users[2], 'bar', 'bbb' );
     277
     278                $q = new WP_User_Query( array(
     279                        'fields' => 'ids',
     280                        'meta_query' => array(
     281                                'foo_key' => array(
     282                                        'key' => 'foo',
     283                                        'compare' => 'EXISTS',
     284                                ),
     285                                'bar_key' => array(
     286                                        'key' => 'bar',
     287                                        'compare' => 'EXISTS',
     288                                ),
     289                        ),
     290                        'orderby' => array(
     291                                'foo_key' => 'asc',
     292                                'bar_key' => 'desc',
     293                        ),
     294                ) );
     295
     296                $this->assertEquals( array( $users[2], $users[0], $users[1] ), $q->results );
    180297        }
    181298
Note: See TracChangeset for help on using the changeset viewer.