Taxonomy: Add update_term_count action that fires when term counts are updated.

This allows plugins to run custom queries only when a term count is actually updated and not on every update of terms or posts.

Follow-up to [60365], [60510].

Props leonidasmilossis, peterwilsoncc, mukesh27, rollybueno, SergeyBiryukov.
Fixes #63904.

git-svn-id: https://develop.svn.wordpress.org/trunk@60711 602fd350-edb4-49c9-b593-d223f7449a82

Author: SergeyBiryukov

src/wp-includes/taxonomy.php

@@ -4175,26 +4175,37 @@ function _update_post_term_count( $terms, $taxonomy ) {
 	 */
 	$post_statuses = esc_sql( apply_filters( 'update_post_term_count_statuses', $post_statuses, $taxonomy ) );
 
-	foreach ( (array) $terms as $term ) {
+	foreach ( (array) $terms as $tt_id ) {
 		$count = 0;
 
 		// Attachments can be 'inherit' status, we need to base count off the parent's status if so.
 		if ( $check_attachments ) {
 			// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration
-			$count += (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts p1 WHERE p1.ID = $wpdb->term_relationships.object_id AND ( post_status IN ('" . implode( "', '", $post_statuses ) . "') OR ( post_status = 'inherit' AND post_parent > 0 AND ( SELECT post_status FROM $wpdb->posts WHERE ID = p1.post_parent ) IN ('" . implode( "', '", $post_statuses ) . "') ) ) AND post_type = 'attachment' AND term_taxonomy_id = %d", $term ) );
+			$count += (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts p1 WHERE p1.ID = $wpdb->term_relationships.object_id AND ( post_status IN ('" . implode( "', '", $post_statuses ) . "') OR ( post_status = 'inherit' AND post_parent > 0 AND ( SELECT post_status FROM $wpdb->posts WHERE ID = p1.post_parent ) IN ('" . implode( "', '", $post_statuses ) . "') ) ) AND post_type = 'attachment' AND term_taxonomy_id = %d", $tt_id ) );
 		}
 
 		if ( $object_types ) {
 			// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration
-			$count += (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts WHERE $wpdb->posts.ID = $wpdb->term_relationships.object_id AND post_status IN ('" . implode( "', '", $post_statuses ) . "') AND post_type IN ('" . implode( "', '", $object_types ) . "') AND term_taxonomy_id = %d", $term ) );
+			$count += (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts WHERE $wpdb->posts.ID = $wpdb->term_relationships.object_id AND post_status IN ('" . implode( "', '", $post_statuses ) . "') AND post_type IN ('" . implode( "', '", $object_types ) . "') AND term_taxonomy_id = %d", $tt_id ) );
 		}
 
+		/**
+		 * Fires when a term count is calculated, before it is updated in the database.
+		 *
+		 * @since 6.9.0
+		 *
+		 * @param int    $tt_id         Term taxonomy ID.
+		 * @param string $taxonomy_name Taxonomy slug.
+		 * @param int    $count         Term count.
+		 */
+		do_action( 'update_term_count', $tt_id, $taxonomy->name, $count );
+
 		/** This action is documented in wp-includes/taxonomy.php */
-		do_action( 'edit_term_taxonomy', $term, $taxonomy->name );
-		$wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) );
+		do_action( 'edit_term_taxonomy', $tt_id, $taxonomy->name );
+		$wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $tt_id ) );
 
 		/** This action is documented in wp-includes/taxonomy.php */
-		do_action( 'edited_term_taxonomy', $term, $taxonomy->name );
+		do_action( 'edited_term_taxonomy', $tt_id, $taxonomy->name );
 	}
 }
 
@@ -4216,6 +4227,9 @@ function _update_generic_term_count( $terms, $taxonomy ) {
 	foreach ( (array) $terms as $term ) {
 		$count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $term ) );
 
+		/** This action is documented in wp-includes/taxonomy.php */
+		do_action( 'update_term_count', $term, $taxonomy->name, $count );
+
 		/** This action is documented in wp-includes/taxonomy.php */
 		do_action( 'edit_term_taxonomy', $term, $taxonomy->name );
 		$wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) );

tests/phpunit/tests/post/updateTermCountOnTransitionPostStatus.php

@@ -1,9 +1,9 @@
 <?php
 
 /**
- * Tests for the _update_term_count_on_transition_post_status function.
+ * Tests for the `_update_term_count_on_transition_post_status()` function.
  *
- * See Tests_Term_WpSetObjectTerms for tests that cover changing terms on a post when saving it.
+ * See `Tests_Term_WpSetObjectTerms` for tests that cover changing terms on a post when saving it.
  *
  * @group taxonomy
  *
@@ -139,9 +139,13 @@ public function test_update_term_count_on_delete() {
 	 * @ticket 42522
 	 */
 	public function test_term_count_is_not_recalculated_when_status_does_not_change() {
-		// Create a mock action for `edited_term_taxonomy` to prevent flaky test.
-		$action = new MockAction();
-		add_action( 'edited_term_taxonomy', array( $action, 'action' ) );
+		// Create a mock action for checking the `edited_term_taxonomy` hook call count.
+		$edited_term_taxonomy_action = new MockAction();
+		add_action( 'edited_term_taxonomy', array( $edited_term_taxonomy_action, 'action' ) );
+
+		// Create a mock action for checking the `update_term_count` hook call count.
+		$update_term_count_action = new MockAction();
+		add_action( 'update_term_count', array( $update_term_count_action, 'action' ) );
 
 		$post_id = self::factory()->post->create(
 			array(
@@ -155,7 +159,8 @@ public function test_term_count_is_not_recalculated_when_status_does_not_change(
 			self::$term_id,
 			self::$taxonomy
 		);
-		$edited_term_taxonomy_count = $action->get_call_count();
+		$edited_term_taxonomy_count     = $edited_term_taxonomy_action->get_call_count();
+		$update_term_count_action_count = $update_term_count_action->get_call_count();
 
 		// Change something about the post but not its status.
 		wp_update_post(
@@ -165,7 +170,8 @@ public function test_term_count_is_not_recalculated_when_status_does_not_change(
 			)
 		);
 
-		$this->assertSame( 0, $action->get_call_count() - $edited_term_taxonomy_count, 'Term taxonomy count should not be recalculated when post status does not change.' );
+		$this->assertSame( 0, $edited_term_taxonomy_action->get_call_count() - $edited_term_taxonomy_count, 'Term taxonomy count should not be recalculated when post status does not change.' );
+		$this->assertSame( 0, $update_term_count_action->get_call_count() - $update_term_count_action_count, 'The `update_term_count` action should not run when term taxonomy count is not recalculated.' );
 		$this->assertTermCount( 2, self::$term_id );
 	}
 
@@ -177,9 +183,13 @@ public function test_term_count_is_not_recalculated_when_status_does_not_change(
 	 * @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' ) );
+		// Create a mock action for checking the `edited_term_taxonomy` hook call count.
+		$edited_term_taxonomy_action = new MockAction();
+		add_action( 'edited_term_taxonomy', array( $edited_term_taxonomy_action, 'action' ) );
+
+		// Create a mock action for checking the `update_term_count` hook call count.
+		$update_term_count_action = new MockAction();
+		add_action( 'update_term_count', array( $update_term_count_action, 'action' ) );
 
 		// Register a custom status that is included in term counts.
 		register_post_status(
@@ -206,7 +216,8 @@ static function ( $status ) {
 			)
 		);
 
-		$this->assertSame( 0, $action->get_call_count(), 'Term taxonomy count should not be recalculated both statuses are included in term counts.' );
+		$this->assertSame( 0, $edited_term_taxonomy_action->get_call_count(), 'Term taxonomy count should not be recalculated when both statuses are included in term counts.' );
+		$this->assertSame( 0, $update_term_count_action->get_call_count(), 'The `update_term_count` action should not run when term taxonomy count is not recalculated.' );
 		$this->assertTermCount( 1, self::$term_id, 'Term count should remain unchanged when transitioning between post statuses that are counted.' );
 	}
 
@@ -218,9 +229,13 @@ static function ( $status ) {
 	 * @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' ) );
+		// Create a mock action for checking the `edited_term_taxonomy` hook call count.
+		$edited_term_taxonomy_action = new MockAction();
+		add_action( 'edited_term_taxonomy', array( $edited_term_taxonomy_action, 'action' ) );
+
+		// Create a mock action for checking the `update_term_count` hook call count.
+		$update_term_count_action = new MockAction();
+		add_action( 'update_term_count', array( $update_term_count_action, 'action' ) );
 
 		// Change post status to draft.
 		wp_update_post(
@@ -230,7 +245,8 @@ public function test_term_count_is_not_recalculated_when_neither_status_is_count
 			)
 		);
 
-		$edited_term_taxonomy_count = $action->get_call_count();
+		$edited_term_taxonomy_count     = $edited_term_taxonomy_action->get_call_count();
+		$update_term_count_action_count = $update_term_count_action->get_call_count();
 
 		// Change the post to another status that is not included in term counts.
 		wp_update_post(
@@ -240,7 +256,8 @@ public function test_term_count_is_not_recalculated_when_neither_status_is_count
 			)
 		);
 
-		$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->assertSame( 0, $edited_term_taxonomy_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->assertSame( 0, $update_term_count_action->get_call_count() - $update_term_count_action_count, 'The `update_term_count` action should not run when term taxonomy count is not recalculated.' );
 		$this->assertTermCount( 0, self::$term_id, 'Term count should remain unchanged when transitioning between post statuses that are not counted.' );
 	}
 
@@ -250,9 +267,13 @@ public function test_term_count_is_not_recalculated_when_neither_status_is_count
 	 * @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' ) );
+		// Create a mock action for checking the `edited_term_taxonomy` hook call count.
+		$edited_term_taxonomy_action = new MockAction();
+		add_action( 'edited_term_taxonomy', array( $edited_term_taxonomy_action, 'action' ) );
+
+		// Create a mock action for checking the `update_term_count` hook call count.
+		$update_term_count_action = new MockAction();
+		add_action( 'update_term_count', array( $update_term_count_action, 'action' ) );
 
 		$custom_taxonomy = 'category_with_pending';
 
@@ -293,7 +314,8 @@ static function ( array $statuses, WP_Taxonomy $taxonomy ) use ( $custom_taxonom
 			$custom_taxonomy
 		);
 
-		$edited_term_taxonomy_count = $action->get_call_count();
+		$edited_term_taxonomy_count     = $edited_term_taxonomy_action->get_call_count();
+		$update_term_count_action_count = $update_term_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(
@@ -303,7 +325,8 @@ static function ( array $statuses, WP_Taxonomy $taxonomy ) use ( $custom_taxonom
 			)
 		);
 
-		$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->assertSame( 1, $edited_term_taxonomy_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->assertSame( 1, $update_term_count_action->get_call_count() - $update_term_count_action_count, 'The `update_term_count` action should run when term taxonomy count is recalculated.' );
 		$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.' );
 	}