<!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>[56747] trunk: Comments: Improve WP_Comment_Query count query performance by setting 'order by' to 'none'.</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/56747">56747</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/56747","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>2023-09-29 17:11:21 +0000 (Fri, 29 Sep 2023)</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 WP_Comment_Query count query performance by setting 'order by' to 'none'.
In cases where `WP_Comment_Query` or `get_comments` is employed with the 'count' parameter set to true, specify 'order by' as 'none'. Since these queries serve solely to determine the count of comments matching specific query parameters, the 'order by' clause becomes redundant and places unnecessary strain on the database server, resulting in slower query execution. Given that count queries are executed on every admin request to retrieve comment counts, this change enhances the performance of the wp-admin interface.
Props guss77, davidbaumwald, SergeyBiryukov, westonruter, peterwilsoncc, foliovision, hareesh-pillai, spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/58368">#58368</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpcommentslisttablephp">trunk/src/wp-admin/includes/class-wp-comments-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesmetaboxesphp">trunk/src/wp-admin/includes/meta-boxes.php</a></li>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php</a></li>
<li><a href="#trunktestsphpunittestscommentqueryphp">trunk/tests/phpunit/tests/comment/query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpcommentslisttablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-comments-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-comments-list-table.php 2023-09-29 15:22:12 UTC (rev 56746)
+++ trunk/src/wp-admin/includes/class-wp-comments-list-table.php 2023-09-29 17:11:21 UTC (rev 56747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -177,9 +177,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array_merge(
</span><span class="cx" style="display: block; padding: 0 10px"> $args,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'count' => true,
- 'offset' => 0,
- 'number' => 0,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'count' => true,
+ 'offset' => 0,
+ 'number' => 0,
+ 'orderby' => 'none',
</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"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -298,6 +299,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_id' => $post_id ? $post_id : 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_id' => $current_user_id,
</span><span class="cx" style="display: block; padding: 0 10px"> 'count' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'orderby' => 'none',
</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"> $link = add_query_arg( 'user_id', $current_user_id, $link );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -518,8 +520,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $comment_types as $type => $label ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( get_comments(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'number' => 1,
- 'type' => $type,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'count' => true,
+ 'orderby' => 'none',
+ 'type' => $type,
</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"> printf(
</span></span></pre></div>
<a id="trunksrcwpadminincludesmetaboxesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/meta-boxes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/meta-boxes.php 2023-09-29 15:22:12 UTC (rev 56746)
+++ trunk/src/wp-admin/includes/meta-boxes.php 2023-09-29 17:11:21 UTC (rev 56747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -901,8 +901,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $total = get_comments(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_id' => $post->ID,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'number' => 1,
</del><span class="cx" style="display: block; padding: 0 10px"> 'count' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'orderby' => 'none',
</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"> $wp_list_table = _get_list_table( 'WP_Post_Comments_List_Table' );
</span></span></pre></div>
<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 2023-09-29 15:22:12 UTC (rev 56746)
+++ trunk/src/wp-includes/comment.php 2023-09-29 17:11:21 UTC (rev 56747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -396,6 +396,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'count' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_comment_meta_cache' => false,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'orderby' => 'none',
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $post_id > 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args['post_id'] = $post_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1114,6 +1115,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'fields' => 'ids',
</span><span class="cx" style="display: block; padding: 0 10px"> 'count' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'status' => 'approve',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'orderby' => 'none',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'parent' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'date_query' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp"></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/rest-api/endpoints/class-wp-rest-comments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2023-09-29 15:22:12 UTC (rev 56746)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2023-09-29 17:11:21 UTC (rev 56747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -295,8 +295,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Out-of-bounds, run the query again without LIMIT for total count.
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $prepared_args['number'], $prepared_args['offset'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $query = new WP_Comment_Query();
- $prepared_args['count'] = true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $query = new WP_Comment_Query();
+ $prepared_args['count'] = true;
+ $prepared_args['orderby'] = 'none';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $total_comments = $query->query( $prepared_args );
</span><span class="cx" style="display: block; padding: 0 10px"> $max_pages = ceil( $total_comments / $request['per_page'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1188,8 +1189,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Only grab one comment to verify the comment has children.
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_children = $comment->get_children(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'number' => 1,
- 'count' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'count' => true,
+ 'orderby' => 'none',
</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">
</span></span></pre></div>
<a id="trunktestsphpunittestscommentqueryphp"></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/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/query.php 2023-09-29 15:22:12 UTC (rev 56746)
+++ trunk/tests/phpunit/tests/comment/query.php 2023-09-29 17:11:21 UTC (rev 56747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3091,7 +3091,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $q = new WP_Comment_Query();
</span><span class="cx" style="display: block; padding: 0 10px"> $found = $q->query(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'count' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'count' => true,
+ 'orderby' => 'none',
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3129,6 +3130,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $found = $q->query(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'count' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'orderby' => 'none',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'meta_query' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'key' => 'foo',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5001,10 +5003,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $query_1 = $q->query(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'fields' => 'ids',
- 'number' => 3,
- 'order' => 'ASC',
- 'count' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'fields' => 'ids',
+ 'number' => 3,
+ 'orderby' => 'none',
+ 'count' => true,
</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"> $number_of_queries = get_num_queries();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5011,10 +5013,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $query_2 = $q->query(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'fields' => 'ids',
- 'number' => 3,
- 'order' => 'ASC',
- 'count' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'fields' => 'ids',
+ 'number' => 3,
+ 'orderby' => 'none',
+ 'count' => true,
</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"> $this->assertSame( $number_of_queries, get_num_queries() );
</span></span></pre>
</div>
</div>
</body>
</html>