Changeset 34806

Timestamp:

10/03/2015 07:25:25 PM (11 years ago)

Author:

boonebgorges

Message:

Use 'comments_per_page' option as fallback in get_page_of_comment().

The function now uses the following order of precedence when calculating
comment pagination: 1. the 'per_page' value passed in the $args array,

2. the 'comments_per_page' query var in $wp_query, and 3. the

'comments_per_page' setting from options-discussion.php. This change allows
get_page_of_comment() to return an accurate value before the main query
has been run.

Props laceous.
See #13939.

Location:

trunk

Files:

• src/wp-includes/comment-functions.php (modified) (1 diff)
• tests/phpunit/tests/comment/getPageOfComment.php (modified) (1 diff)

trunk/src/wp-includes/comment-functions.php

@@ -856 +856 @@
         $args = wp_parse_args( $args, $defaults );
 
-        if ( '' === $args['per_page'] )
-                $args['per_page'] = get_query_var('comments_per_page');
+        // Order of precedence: 1. `$args['per_page']`, 2. 'comments_per_page' query_var, 3. 'comments_per_page' option.
+        if ( '' === $args['per_page'] ) {
+                $args['per_page'] = get_query_var( 'comments_per_page' );
+        }
+
+        if ( '' === $args['per_page'] ) {
+                $args['per_page'] = get_option( 'comments_per_page' );
+        }
+
         if ( empty($args['per_page']) ) {
                 $args['per_page'] = 0;

trunk/tests/phpunit/tests/comment/getPageOfComment.php

@@ -227 +227 @@
                 }
         }
+
+        /**
+         * @ticket 13939
+         */
+        public function test_comments_per_page_option_should_be_fallback_when_query_var_is_not_available() {
+                $now = time();
+
+                $p = $this->factory->post->create();
+                $c1 = $this->factory->comment->create( array( 'comment_post_ID' => $p, 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now ) ) );
+                $c2 = $this->factory->comment->create( array( 'comment_post_ID' => $p, 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 20 ) ) );
+                $c3 = $this->factory->comment->create( array( 'comment_post_ID' => $p, 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 30 ) ) );
+
+                update_option( 'comments_per_page', 2 );
+
+                $this->assertEquals( 2, get_page_of_comment( $c1 ) );
+        }
 }