Changeset 36226 for trunk

Timestamp:

01/08/2016 10:16:11 PM (9 years ago)

Author:

boonebgorges

Message:

In comments_template(), don't run hierarchical queries if comment threading is disabled.

When hierarchical=true, WP_Comment_Query will always fetch comments according
to the comment hierarchy, even if 'thread_comments' is disabled for the site.
This can cause problems when comment threading is disabled after threaded
comments have been recorded on the site; comments will no longer be returned in
a strictly chronological order.

We address the issue by refraining from querying hierarchically when comment
threading is disabled.

Props jmdodd.
Fixes #35378.

Location:

trunk

Files:

• src/wp-includes/comment-template.php (modified) (2 diffs)
• tests/phpunit/tests/comment/commentsTemplate.php (modified) (1 diff)

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

@@ -1287 +1287 @@
         'status'  => 'approve',
         'post_id' => $post->ID,
-        'hierarchical' => 'threaded',
         'no_found_rows' => false,
         'update_comment_meta_cache' => false, // We lazy-load comment meta for performance.
     );
+
+    if ( get_option('thread_comments') ) {
+        $comment_args['hierarchical'] = 'threaded';
+    } else {
+        $comment_args['hierarchical'] = false;
+    }
 
     if ( $user_ID ) {
@@ -1337 +1342 @@
 
     // Trees must be flattened before they're passed to the walker.
-    $comments_flat = array();
-    foreach ( $_comments as $_comment ) {
-        $comments_flat[]  = $_comment;
-        $comment_children = $_comment->get_children( array(
-            'format' => 'flat',
-            'status' => $comment_args['status'],
-            'orderby' => $comment_args['orderby']
-        ) );
-
-        foreach ( $comment_children as $comment_child ) {
-            $comments_flat[] = $comment_child;
+    if ( $comment_args['hierarchical'] ) {
+        $comments_flat = array();
+        foreach ( $_comments as $_comment ) {
+            $comments_flat[]  = $_comment;
+            $comment_children = $_comment->get_children( array(
+                'format' => 'flat',
+                'status' => $comment_args['status'],
+                'orderby' => $comment_args['orderby']
+            ) );
+
+            foreach ( $comment_children as $comment_child ) {
+                $comments_flat[] = $comment_child;
+            }
         }
+    } else {
+        $comments_flat = $_comments;
     }
 

trunk/tests/phpunit/tests/comment/commentsTemplate.php

@@ -690 +690 @@
         return $commenter;
     }
+
+    /**
+     * @ticket 35378
+     */
+    public function test_hierarchy_should_be_ignored_when_threading_is_disabled() {
+        $now = time();
+        $p = self::factory()->post->create();
+        $comment_1 = self::factory()->comment->create( array(
+            'comment_post_ID' => $p,
+            'comment_content' => '1',
+            'comment_approved' => '1',
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+        ) );
+        $comment_2 = self::factory()->comment->create( array(
+            'comment_post_ID' => $p,
+            'comment_content' => '2',
+            'comment_approved' => '1',
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 300 ),
+        ) );
+        $comment_3 = self::factory()->comment->create( array(
+            'comment_post_ID' => $p,
+            'comment_content' => '3',
+            'comment_approved' => '1',
+            'comment_parent' => $comment_1,
+            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+        ) );
+
+        update_option( 'comment_order', 'asc' );
+        update_option( 'thread_comments', 0 );
+
+        $this->go_to( get_permalink( $p ) );
+        $found = get_echo( 'comments_template' );
+
+        // Find the found comments in the markup.
+        preg_match_all( '|id="comment-([0-9]+)|', $found, $matches );
+
+        $found_cids = array_map( 'intval', $matches[1] );
+        $this->assertSame( array( $comment_2, $comment_3, $comment_1 ), $found_cids );
+    }
 }