<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[53036] trunk: Comments: Improve performance of the `wp_count_comments` function.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/53036">53036</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53036","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-03-31 09:07:02 +0000 (Thu, 31 Mar 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/19901">#19901</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunktestsphpunittestscommentgetCommentCountphp">trunk/tests/phpunit/tests/comment/getCommentCount.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2022-03-31 08:15:30 UTC (rev 53035)
+++ trunk/src/wp-includes/comment.php 2022-03-31 09:07:02 UTC (rev 53036)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -383,21 +383,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = (int) $post_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $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
- );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $comment_count = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'approved' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'awaiting_moderation' => 0,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -408,33 +393,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'all' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array(
+ 'count' => true,
+ 'update_comment_meta_cache' => false,
+ );
+ if ( $post_id > 0 ) {
+ $args['post_id'] = $post_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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 ) ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_count['all'] = $comment_count['approved'] + $comment_count['awaiting_moderation'];
+ $comment_count['total_comments'] = $comment_count['all'] + $comment_count['spam'];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return array_map( 'intval', $comment_count );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestscommentgetCommentCountphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/comment/getCommentCount.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/getCommentCount.php 2022-03-31 08:15:30 UTC (rev 53035)
+++ trunk/tests/phpunit/tests/comment/getCommentCount.php 2022-03-31 09:07:02 UTC (rev 53036)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,6 +11,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 0, $count['trash'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 0, $count['post-trashed'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 0, $count['total_comments'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 0, $count['all'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_comment_count_approved() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -97,4 +98,73 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 1, $count['post-trashed'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 0, $count['total_comments'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @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'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>