<!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>[60510] trunk: Posts, Post Types: Don't unnecessarily recount terms when a post transitions between statuses that don't require them to be recounted.</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/60510">60510</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/60510","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-07-25 08:35:12 +0000 (Fri, 25 Jul 2025)</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'>Posts, Post Types: Don't unnecessarily recount terms when a post transitions between statuses that don't require them to be recounted.
This accounts for transitions where:
* Both the old and new statuses are not included in term counts.
* Both the old and new statuses are included in term counts.
This results in term counts only being recalculated when a post transitions between a counted and an uncounted status.
If the terms of the post are changed then the term recounting is still handled by `wp_update_term_count()` inside `wp_set_object_terms()`.
Props hbhalodia, johnbillion, peterwilsoncc, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/63562">#63562</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
<li><a href="#trunktestsphpunittestspostupdateTermCountOnTransitionPostStatusphp">trunk/tests/phpunit/tests/post/updateTermCountOnTransitionPostStatus.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespostphp"></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/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2025-07-24 15:00:42 UTC (rev 60509)
+++ trunk/src/wp-includes/post.php 2025-07-25 08:35:12 UTC (rev 60510)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8175,9 +8175,30 @@
</span><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"> // Update counts for the post's terms.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( (array) get_object_taxonomies( $post->post_type ) as $taxonomy ) {
- $tt_ids = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'tt_ids' ) );
- wp_update_term_count( $tt_ids, $taxonomy );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( (array) get_object_taxonomies( $post->post_type, 'objects' ) as $taxonomy ) {
+ /** This filter is documented in wp-includes/taxonomy.php */
+ $counted_statuses = apply_filters( 'update_post_term_count_statuses', array( 'publish' ), $taxonomy );
+
+ /*
+ * Do not recalculate term count if both the old and new status are not included in term counts.
+ * This accounts for a transition such as draft -> pending.
+ */
+ if ( ! in_array( $old_status, $counted_statuses, true ) && ! in_array( $new_status, $counted_statuses, true ) ) {
+ continue;
+ }
+
+ /*
+ * Do not recalculate term count if both the old and new status are included in term counts.
+ *
+ * This accounts for transitioning between statuses which are both included in term counts. This can only occur
+ * if the `update_post_term_count_statuses` filter is in use to count more than just the 'publish' status.
+ */
+ if ( in_array( $old_status, $counted_statuses, true ) && in_array( $new_status, $counted_statuses, true ) ) {
+ continue;
+ }
+
+ $tt_ids = wp_get_object_terms( $post->ID, $taxonomy->name, array( 'fields' => 'tt_ids' ) );
+ wp_update_term_count( $tt_ids, $taxonomy->name );
</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="trunktestsphpunittestspostupdateTermCountOnTransitionPostStatusphp"></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/post/updateTermCountOnTransitionPostStatus.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/updateTermCountOnTransitionPostStatus.php 2025-07-24 15:00:42 UTC (rev 60509)
+++ trunk/tests/phpunit/tests/post/updateTermCountOnTransitionPostStatus.php 2025-07-25 08:35:12 UTC (rev 60510)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -139,6 +139,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 42522
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_term_count_is_not_recalculated_when_status_does_not_change() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Create a mock action for `edited_term_taxonomy` to prevent flaky test.
+ $action = new MockAction();
+ add_action( 'edited_term_taxonomy', array( $action, 'action' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_type' => self::$post_type,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -151,7 +155,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self::$term_id,
</span><span class="cx" style="display: block; padding: 0 10px"> self::$taxonomy
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $edited_term_taxonomy_count = did_action( 'edited_term_taxonomy' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $edited_term_taxonomy_count = $action->get_call_count();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Change something about the post but not its status.
</span><span class="cx" style="display: block; padding: 0 10px"> wp_update_post(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -161,11 +165,150 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 0, did_action( 'edited_term_taxonomy' ) - $edited_term_taxonomy_count, 'Term taxonomy count should not be recalculated when post status does not change.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 0, $action->get_call_count() - $edited_term_taxonomy_count, 'Term taxonomy count should not be recalculated when post status does not change.' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertTermCount( 2, self::$term_id );
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test that the term count is not recalculated when both the old and new status are included in term counts.
+ *
+ * This accounts for a transition such as draft -> pending.
+ *
+ * @ticket 63562
+ */
+ public function test_term_count_is_not_recalculated_when_both_status_are_counted() {
+ // Create a mock action for `edited_term_taxonomy` to prevent flaky test.
+ $action = new MockAction();
+ add_action( 'edited_term_taxonomy', array( $action, 'action' ) );
+
+ // Register a custom status that is included in term counts.
+ register_post_status(
+ 'counted',
+ array(
+ 'label' => 'Counted',
+ 'public' => true,
+ )
+ );
+
+ add_filter(
+ 'update_post_term_count_statuses',
+ static function ( $status ) {
+ $status[] = 'counted';
+ return $status;
+ }
+ );
+
+ // Change the post to another status that is included in term counts.
+ wp_update_post(
+ array(
+ 'ID' => self::$post_id,
+ 'post_status' => 'counted',
+ )
+ );
+
+ $this->assertSame( 0, $action->get_call_count(), 'Term taxonomy count should not be recalculated both statuses are included in term counts.' );
+ $this->assertTermCount( 1, self::$term_id, 'Term count should remain unchanged when transitioning between post statuses that are counted.' );
+ }
+
+ /**
+ * Test that the term count is not recalculated when neither the old nor new status are included in term counts.
+ *
+ * This accounts for a transition such as draft -> pending.
+ *
+ * @ticket 63562
+ */
+ public function test_term_count_is_not_recalculated_when_neither_status_is_counted() {
+ // Create a mock action for `edited_term_taxonomy` to prevent flaky test.
+ $action = new MockAction();
+ add_action( 'edited_term_taxonomy', array( $action, 'action' ) );
+
+ // Change post status to draft.
+ wp_update_post(
+ array(
+ 'ID' => self::$post_id,
+ 'post_status' => 'draft',
+ )
+ );
+
+ $edited_term_taxonomy_count = $action->get_call_count();
+
+ // Change the post to another status that is not included in term counts.
+ wp_update_post(
+ array(
+ 'ID' => self::$post_id,
+ 'post_status' => 'pending',
+ )
+ );
+
+ $this->assertSame( 0, $action->get_call_count() - $edited_term_taxonomy_count, 'Term taxonomy count should not be recalculated when neither new nor old post status is included in term counts.' );
+ $this->assertTermCount( 0, self::$term_id, 'Term count should remain unchanged when transitioning between post statuses that are not counted.' );
+ }
+
+ /**
+ * Test to ensure that the `update_post_term_count_statuses` filter is respected.
+ *
+ * @ticket 63562
+ */
+ public function test_update_post_term_count_statuses_filter_is_respected() {
+ // Create a mock action for `edited_term_taxonomy` to prevent flaky test.
+ $action = new MockAction();
+ add_action( 'edited_term_taxonomy', array( $action, 'action' ) );
+
+ $custom_taxonomy = 'category_with_pending';
+
+ // Add a custom taxonomy that includes 'pending' in its term counts.
+ register_taxonomy(
+ $custom_taxonomy,
+ self::$post_type
+ );
+ add_filter(
+ 'update_post_term_count_statuses',
+ static function ( array $statuses, WP_Taxonomy $taxonomy ) use ( $custom_taxonomy ): array {
+ if ( $custom_taxonomy === $taxonomy->name ) {
+ $statuses[] = 'pending';
+ }
+
+ return $statuses;
+ },
+ 10,
+ 2
+ );
+
+ // Change post status to draft and give it a term to count.
+ wp_update_post(
+ array(
+ 'ID' => self::$post_id,
+ 'post_status' => 'draft',
+ )
+ );
+ $custom_term_id = self::factory()->term->create(
+ array(
+ 'taxonomy' => $custom_taxonomy,
+ 'name' => 'Hello',
+ )
+ );
+ wp_set_object_terms(
+ self::$post_id,
+ $custom_term_id,
+ $custom_taxonomy
+ );
+
+ $edited_term_taxonomy_count = $action->get_call_count();
+
+ // Change the post to another status that is included in term counts for one of its two taxonomies.
+ wp_update_post(
+ array(
+ 'ID' => self::$post_id,
+ 'post_status' => 'pending',
+ )
+ );
+
+ $this->assertSame( 1, $action->get_call_count() - $edited_term_taxonomy_count, 'Term taxonomy count should respect the statuses returned by the update_post_term_count_statuses filter.' );
+ $this->assertTermCount( 0, self::$term_id, 'Term count for the default taxonomy should remain zero since "pending" is not included in its countable statuses.' );
+ $this->assertTermCount( 1, $custom_term_id, 'Term count for the custom taxonomy should be updated to 1 because the "pending" status is included via the update_post_term_count_statuses filter.' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Assert that the term count is correct.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.9.0
</span></span></pre>
</div>
</div>
</body>
</html>