WordPress.org

Make WordPress Core

Changeset 36226


Ignore:
Timestamp:
01/08/2016 10:16:11 PM (4 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:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/comment-template.php

    r36157 r36226  
    12871287        'status'  => 'approve',
    12881288        'post_id' => $post->ID,
    1289         'hierarchical' => 'threaded',
    12901289        'no_found_rows' => false,
    12911290        'update_comment_meta_cache' => false, // We lazy-load comment meta for performance.
    12921291    );
     1292
     1293    if ( get_option('thread_comments') ) {
     1294        $comment_args['hierarchical'] = 'threaded';
     1295    } else {
     1296        $comment_args['hierarchical'] = false;
     1297    }
    12931298
    12941299    if ( $user_ID ) {
     
    13371342
    13381343    // Trees must be flattened before they're passed to the walker.
    1339     $comments_flat = array();
    1340     foreach ( $_comments as $_comment ) {
    1341         $comments_flat[]  = $_comment;
    1342         $comment_children = $_comment->get_children( array(
    1343             'format' => 'flat',
    1344             'status' => $comment_args['status'],
    1345             'orderby' => $comment_args['orderby']
    1346         ) );
    1347 
    1348         foreach ( $comment_children as $comment_child ) {
    1349             $comments_flat[] = $comment_child;
     1344    if ( $comment_args['hierarchical'] ) {
     1345        $comments_flat = array();
     1346        foreach ( $_comments as $_comment ) {
     1347            $comments_flat[]  = $_comment;
     1348            $comment_children = $_comment->get_children( array(
     1349                'format' => 'flat',
     1350                'status' => $comment_args['status'],
     1351                'orderby' => $comment_args['orderby']
     1352            ) );
     1353
     1354            foreach ( $comment_children as $comment_child ) {
     1355                $comments_flat[] = $comment_child;
     1356            }
    13501357        }
     1358    } else {
     1359        $comments_flat = $_comments;
    13511360    }
    13521361
  • trunk/tests/phpunit/tests/comment/commentsTemplate.php

    r36040 r36226  
    690690        return $commenter;
    691691    }
     692
     693    /**
     694     * @ticket 35378
     695     */
     696    public function test_hierarchy_should_be_ignored_when_threading_is_disabled() {
     697        $now = time();
     698        $p = self::factory()->post->create();
     699        $comment_1 = self::factory()->comment->create( array(
     700            'comment_post_ID' => $p,
     701            'comment_content' => '1',
     702            'comment_approved' => '1',
     703            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
     704        ) );
     705        $comment_2 = self::factory()->comment->create( array(
     706            'comment_post_ID' => $p,
     707            'comment_content' => '2',
     708            'comment_approved' => '1',
     709            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 300 ),
     710        ) );
     711        $comment_3 = self::factory()->comment->create( array(
     712            'comment_post_ID' => $p,
     713            'comment_content' => '3',
     714            'comment_approved' => '1',
     715            'comment_parent' => $comment_1,
     716            'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
     717        ) );
     718
     719        update_option( 'comment_order', 'asc' );
     720        update_option( 'thread_comments', 0 );
     721
     722        $this->go_to( get_permalink( $p ) );
     723        $found = get_echo( 'comments_template' );
     724
     725        // Find the found comments in the markup.
     726        preg_match_all( '|id="comment-([0-9]+)|', $found, $matches );
     727
     728        $found_cids = array_map( 'intval', $matches[1] );
     729        $this->assertSame( array( $comment_2, $comment_3, $comment_1 ), $found_cids );
     730    }
    692731}
Note: See TracChangeset for help on using the changeset viewer.