Changeset 41287

Timestamp:

08/21/2017 03:34:19 PM (7 years ago)

Author:

boonebgorges

Message:

Introduce paged argument to WP_Comment_Query.

Using paged with number allows developers to request
paginated comment results without having to do a manual offset
calculation.

Props AdamWills.
Fixes #38268.

Location:

trunk

Files:

• src/wp-includes/class-wp-comment-query.php (modified) (5 diffs)
• tests/phpunit/tests/comment/query.php (modified) (1 diff)

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

@@ -141 +141 @@
      * @since 4.5.0 Introduced the `$author_url` argument.
      * @since 4.6.0 Introduced the `$cache_domain` argument.
+     * @since 4.9.0 Introduced the `$paged` argument.
      *
      * @param string|array $query {
@@ -171 +172 @@
      *     @type int          $number                    Maximum number of comments to retrieve.
      *                                                   Default empty (no limit).
+     *     @type int          $paged                     When used with $number, defines the page of results to return.
+     *                                                   When used with $offset, $offset takes precedence. Default 1.
      *     @type int          $offset                    Number of comments to offset the query. Used to build
      *                                                   LIMIT clause. Default 0.
@@ -264 +267 @@
             'orderby' => '',
             'order' => 'DESC',
+            'paged' => 1,
             'parent' => '',
             'parent__in' => '',
@@ -629 +633 @@
         $number = absint( $this->query_vars['number'] );
         $offset = absint( $this->query_vars['offset'] );
+        $paged = absint( $this->query_vars['paged'] );
 
         if ( ! empty( $number ) ) {
@@ -634 +639 @@
                 $limits = 'LIMIT ' . $offset . ',' . $number;
             } else {
-                $limits = 'LIMIT ' . $number;
+                $limits = 'LIMIT ' . ( $number * ( $paged - 1 ) ) . ',' . $number;
             }
         }

trunk/tests/phpunit/tests/comment/query.php

@@ -1562 +1562 @@
     }
 
+    /**
+     * @ticket 38268
+     */
+    public function test_paged() {
+        $now = time();
+
+        $c1 = self::factory()->comment->create( array(
+            'comment_post_ID' => self::$post_id,
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 50 ),
+        ) );
+        $c2 = self::factory()->comment->create( array(
+            'comment_post_ID' => self::$post_id,
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 40 ),
+        ) );
+        $c3 = self::factory()->comment->create( array(
+            'comment_post_ID' => self::$post_id,
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 30 ),
+        ) );
+        $c4 = self::factory()->comment->create( array(
+            'comment_post_ID' => self::$post_id,
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 20 ),
+        ) );
+
+        $query = new WP_Comment_Query();
+        $found = $query->query( array(
+            'paged' => 2,
+            'number' => 2,
+            'orderby' => 'comment_date_gmt',
+            'order' => 'DESC',
+            'fields' => 'ids',
+        ) );
+
+        $expected = array( $c2, $c1 );
+        $this->assertSame( $expected, $found );
+    }
+
+    /**
+     * @ticket 38268
+     */
+    public function test_offset_should_take_precedence_over_paged() {
+        $now = time();
+
+        $c1 = self::factory()->comment->create( array(
+            'comment_post_ID' => self::$post_id,
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 50 ),
+        ) );
+        $c2 = self::factory()->comment->create( array(
+            'comment_post_ID' => self::$post_id,
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 40 ),
+        ) );
+        $c3 = self::factory()->comment->create( array(
+            'comment_post_ID' => self::$post_id,
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 30 ),
+        ) );
+        $c4 = self::factory()->comment->create( array(
+            'comment_post_ID' => self::$post_id,
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 20 ),
+        ) );
+
+        $query = new WP_Comment_Query();
+        $found = $query->query( array(
+            'paged' => 2,
+            'offset' => 1,
+            'number' => 2,
+            'orderby' => 'comment_date_gmt',
+            'order' => 'DESC',
+            'fields' => 'ids',
+        ) );
+
+        $expected = array( $c3, $c2 );
+
+        $this->assertSame( $expected, $found );
+    }
+
     public function test_post_type_single_value() {
         register_post_type( 'post-type-1' );