Changeset 30016

Timestamp:

10/24/2014 07:50:53 PM (10 years ago)

Author:

boonebgorges

Message:

Accept 'orderby=include' in WP_User_Query.

This lets the results of a user query be sorted manually by the value of the
'include' param.

Props jipmoors.
Fixes #30064.

Location:

trunk

Files:

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

trunk/src/wp-includes/user.php

@@ -599 +599 @@
         $this->query_where = "WHERE 1=1";
 
+        // Parse and sanitize 'include', for use by 'orderby' as well as 'include' below.
+        if ( ! empty( $qv['include'] ) ) {
+            $include = wp_parse_id_list( $qv['include'] );
+        } else {
+            $include = false;
+        }
+
         // sorting
         if ( isset( $qv['orderby'] ) ) {
@@ -622 +629 @@
             } elseif ( 'meta_value' == $qv['orderby'] ) {
                 $orderby = "$wpdb->usermeta.meta_value";
+            } else if ( 'include' === $qv['orderby'] && ! empty( $include ) ) {
+                // Sanitized earlier.
+                $include_sql = implode( ',', $include );
+                $orderby = "FIELD( $wpdb->users.ID, $include_sql )";
             } else {
                 $orderby = 'user_login';
@@ -735 +746 @@
         }
 
-        if ( ! empty( $qv['include'] ) ) {
-            $ids = implode( ',', wp_parse_id_list( $qv['include'] ) );
+        if ( ! empty( $include ) ) {
+            // Sanitized earlier.
+            $ids = implode( ',', $include );
             $this->query_where .= " AND $wpdb->users.ID IN ($ids)";
         } elseif ( ! empty( $qv['exclude'] ) ) {

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

@@ -133 +133 @@
 
         $this->assertEquals( $names, $values );
+    }
+
+    /**
+     * @ticket 30064
+     */
+    public function test_orderby_include_with_empty_include() {
+        $q = new WP_User_Query( array(
+            'orderby' => 'include',
+        ) );
+
+        $this->assertContains( 'ORDER BY user_login', $q->query_orderby );
+    }
+
+    /**
+     * @ticket 30064
+     */
+    public function test_orderby_include() {
+        global $wpdb;
+
+        $users = $this->factory->user->create_many( 4 );
+        $q = new WP_User_Query( array(
+            'orderby' => 'include',
+            'include' => array( $users[1], $users[0], $users[3] ),
+            'fields' => '',
+        ) );
+
+        $expected_orderby = 'ORDER BY FIELD( ' . $wpdb->users . '.ID, ' . $users[1] . ',' . $users[0] . ',' . $users[3] . ' )';
+        $this->assertContains( $expected_orderby, $q->query_orderby );
+
+        // assertEquals() respects order but ignores type (get_results() returns numeric strings).
+        $this->assertEquals( array( $users[1], $users[0], $users[3] ), $q->get_results() );
+    }
+
+    /**
+     * @ticket 30064
+     */
+    public function test_orderby_include_duplicate_values() {
+        global $wpdb;
+
+        $users = $this->factory->user->create_many( 4 );
+        $q = new WP_User_Query( array(
+            'orderby' => 'include',
+            'include' => array( $users[1], $users[0], $users[1], $users[3] ),
+            'fields' => '',
+        ) );
+
+        $expected_orderby = 'ORDER BY FIELD( ' . $wpdb->users . '.ID, ' . $users[1] . ',' . $users[0] . ',' . $users[3] . ' )';
+        $this->assertContains( $expected_orderby, $q->query_orderby );
+
+        // assertEquals() respects order but ignores type (get_results() returns numeric strings).
+        $this->assertEquals( array( $users[1], $users[0], $users[3] ), $q->get_results() );
     }