Changeset 53036

Timestamp:

03/31/2022 09:07:02 AM (18 months ago)

Author:

spacedmonkey

Message:

Comments: Improve performance of the wp_count_comments function.

Improve performance of the wp_count_comments function by replacing a complex query with multiple calls to the get_comments function. Passing the count parameter to the get_comments function results in a simple
count query that returns quickly. Using get_comments also means that query is cached and run through filters.

Props FolioVision, markjaquith, nacin, ryan, coffee2code, wonderboymusic, ComputerGuru, jb510, SergeyBiryukov, Znuff, Rahe, uday17035, spacedmonkey, peterwilsoncc.
Fixes #19901.

Location:

trunk

Files:

• src/wp-includes/comment.php (modified) (2 diffs)
• tests/phpunit/tests/comment/getCommentCount.php (modified) (2 diffs)

trunk/src/wp-includes/comment.php

@@ -384 +384 @@
     $post_id = (int) $post_id;
 
-    $where = '';
-    if ( $post_id > 0 ) {
-        $where = $wpdb->prepare( 'WHERE comment_post_ID = %d', $post_id );
-    }
-
-    $totals = (array) $wpdb->get_results(
-        "
-        SELECT comment_approved, COUNT( * ) AS total
-        FROM {$wpdb->comments}
-        {$where}
-        GROUP BY comment_approved
-    ",
-        ARRAY_A
-    );
-
     $comment_count = array(
         'approved'            => 0,
@@ -409 +394 @@
     );
 
-    foreach ( $totals as $row ) {
-        switch ( $row['comment_approved'] ) {
-            case 'trash':
-                $comment_count['trash'] = $row['total'];
-                break;
-            case 'post-trashed':
-                $comment_count['post-trashed'] = $row['total'];
-                break;
-            case 'spam':
-                $comment_count['spam']            = $row['total'];
-                $comment_count['total_comments'] += $row['total'];
-                break;
-            case '1':
-                $comment_count['approved']        = $row['total'];
-                $comment_count['total_comments'] += $row['total'];
-                $comment_count['all']            += $row['total'];
-                break;
-            case '0':
-                $comment_count['awaiting_moderation'] = $row['total'];
-                $comment_count['total_comments']     += $row['total'];
-                $comment_count['all']                += $row['total'];
-                break;
-            default:
-                break;
-        }
-    }
+    $args = array(
+        'count'                     => true,
+        'update_comment_meta_cache' => false,
+    );
+    if ( $post_id > 0 ) {
+        $args['post_id'] = $post_id;
+    }
+    $mapping       = array(
+        'approved'            => 'approve',
+        'awaiting_moderation' => 'hold',
+        'spam'                => 'spam',
+        'trash'               => 'trash',
+        'post-trashed'        => 'post-trashed',
+    );
+    $comment_count = array();
+    foreach ( $mapping as $key => $value ) {
+        $comment_count[ $key ] = get_comments( array_merge( $args, array( 'status' => $value ) ) );
+    }
+
+    $comment_count['all']            = $comment_count['approved'] + $comment_count['awaiting_moderation'];
+    $comment_count['total_comments'] = $comment_count['all'] + $comment_count['spam'];
 
     return array_map( 'intval', $comment_count );

trunk/tests/phpunit/tests/comment/getCommentCount.php

@@ -12 +12 @@
         $this->assertSame( 0, $count['post-trashed'] );
         $this->assertSame( 0, $count['total_comments'] );
+        $this->assertSame( 0, $count['all'] );
     }
 
@@ -98 +99 @@
         $this->assertSame( 0, $count['total_comments'] );
     }
+
+    /**
+     * @ticket 19901
+     *
+     * @covers ::get_comment_count
+     */
+    public function test_get_comment_count_validate_cache_comment_deleted() {
+
+        $comment_id = self::factory()->comment->create();
+
+        $count = get_comment_count();
+
+        $this->assertSame( 1, $count['total_comments'] );
+
+        wp_delete_comment( $comment_id, true );
+
+        $count = get_comment_count();
+
+        $this->assertSame( 0, $count['total_comments'] );
+    }
+
+    /**
+     * @ticket 19901
+     *
+     * @covers ::get_comment_count
+     */
+    public function test_get_comment_count_validate_cache_post_deleted() {
+
+        $post_id = self::factory()->post->create();
+
+        $comment_id = self::factory()->comment->create(
+            array(
+                'comment_post_ID' => $post_id,
+            )
+        );
+
+        $count = get_comment_count( $post_id );
+
+        $this->assertSame( 1, $count['total_comments'] );
+
+        wp_delete_post( $post_id, true );
+
+        $count = get_comment_count( $post_id );
+
+        $this->assertSame( 0, $count['total_comments'] );
+    }
+
+    /**
+     * @ticket 19901
+     *
+     * @covers ::get_comment_count
+     */
+    public function test_get_comment_count_validate_cache_comment_status() {
+        $comment_id = self::factory()->comment->create();
+
+        $count = get_comment_count();
+
+        $this->assertSame( 1, $count['approved'] );
+        $this->assertSame( 0, $count['trash'] );
+        $this->assertSame( 1, $count['total_comments'] );
+
+        wp_set_comment_status( $comment_id, 'trash' );
+
+        $count = get_comment_count();
+
+        $this->assertSame( 0, $count['approved'] );
+        $this->assertSame( 1, $count['trash'] );
+        $this->assertSame( 0, $count['total_comments'] );
+    }
 }