Changeset 34531

Timestamp:

09/25/2015 04:25:20 AM (9 years ago)

Author:

boonebgorges

Message:

Introduce 'paged' parameter for WP_User_Query.

This is an alternative to using 'offset', and manually calculating pagination.
Note that 'paged' works only in conjunction with 'number', the latter of which
provides the per-page value.

Props sebastian.pisula.
Fixes #25145.

Location:

trunk

Files:

• src/wp-includes/class-wp-user-query.php (modified) (4 diffs)
• tests/phpunit/tests/user/query.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-user-query.php

@@ -84 +84 @@
      *              for `$orderby` parameter.
      * @since 4.3.0 Added 'has_published_posts' parameter.
+     * @since 4.4.0 Added 'paged' parameter.
      * @access public
      *
@@ -125 +126 @@
      *                                             conjunction with pagination. Value -1 (all) is not supported.
      *                                             Default empty (all users).
+     *     @type int          $paged               When used with number, defines the page of results to return.
+     *                                             Default 1.
      *     @type bool         $count_total         Whether to count the total number of users found. If pagination
      *                                             is not needed, setting this to false can improve performance.
@@ -158 +161 @@
                 'offset' => '',
                 'number' => '',
+                'paged' => 1,
                 'count_total' => true,
                 'fields' => 'all',
@@ -324 +328 @@
         // limit
         if ( isset( $qv['number'] ) && $qv['number'] ) {
-            if ( $qv['offset'] )
+            if ( $qv['offset'] ) {
                 $this->query_limit = $wpdb->prepare("LIMIT %d, %d", $qv['offset'], $qv['number']);
-            else
-                $this->query_limit = $wpdb->prepare("LIMIT %d", $qv['number']);
+            } else {
+                $this->query_limit = $wpdb->prepare( "LIMIT %d, %d", $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
+            }
         }
 

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

@@ -460 +460 @@
         $query->prepare_query( array( 'number' => 8 ) );
         $this->assertNotEmpty( $query->query_limit );
-        $this->assertEquals( 'LIMIT 8', $query->query_limit );
+        $this->assertEquals( 'LIMIT 0, 8', $query->query_limit );
 
         // All values get reset
@@ -858 +858 @@
         $this->assertEqualSets( $expected, $found );
     }
+
+    /**
+     * @ticket 25145
+     */
+    public function test_paged() {
+        $users = $this->factory->user->create_many( 5 );
+
+        $q = new WP_User_Query( array(
+            'number' => 2,
+            'paged' => 2,
+            'orderby' => 'ID',
+            'order' => 'DESC', // Avoid funkiness with user 1.
+            'fields' => 'ids',
+        ) );
+
+        $this->assertEquals( array( $users[2], $users[1] ), $q->results );
+    }
 }