Changeset 50169

Timestamp:

02/02/2021 09:04:58 PM (4 years ago)

Author:

antpb

Message:

Taxonomy: Add filter for post statuses when updating term count.

This adds a filter that allows $post_statuses to be modified in term count.

Props GunGeekATX, adamsilverstein, davecpage, nwjames, hellofromTonya, audrasjb, peterwilsoncc, TimothyBlynJacobs.
Fixes #38843.

Location:

trunk

Files:

• src/wp-includes/taxonomy.php (modified) (2 diffs)
• tests/phpunit/tests/term/termCounts.php (modified) (4 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -3892 +3892 @@
     }
 
+    $post_statuses = array( 'publish' );
+
+    /**
+     * Filters the post statuses for updating the term count.
+     *
+     * @since 5.7.0
+     *
+     * @param array         $post_statuses List of post statuses to include in the count. Default is 'publish'.
+     * @param WP_Taxonomy   $taxonomy      Current taxonomy object.
+     */
+    $post_statuses = esc_sql( apply_filters( 'update_post_term_count_statuses', $post_statuses, $taxonomy ) );
+
     foreach ( (array) $terms as $term ) {
         $count = 0;
@@ -3897 +3909 @@
         // Attachments can be 'inherit' status, we need to base count off the parent's status if so.
         if ( $check_attachments ) {
-            $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 = 'publish' OR ( post_status = 'inherit' AND post_parent > 0 AND ( SELECT post_status FROM $wpdb->posts WHERE ID = p1.post_parent ) = 'publish' ) ) AND post_type = 'attachment' AND term_taxonomy_id = %d", $term ) );
+            // 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 ) );
         }
 
         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 = 'publish' 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", $term ) );
         }
 

trunk/tests/phpunit/tests/term/termCounts.php

@@ -225 +225 @@
     }
 
-    /**
-     * Term counts incremented correctly for posts with attachment.
-     *
-     * @covers ::wp_update_term_count
-     * @dataProvider data_term_count_changes_for_post_statuses_with_attachments
+    function add_custom_status_to_counted_statuses( $statuses ) {
+        array_push( $statuses, 'custom' );
+        return $statuses;
+    }
+
+    /**
+     * Term counts incremented correctly when the `update_post_term_count_statuses` filter is used.
+     *
+     * @covers ::wp_update_term_count
+     * @dataProvider data_term_count_changes_for_update_post_term_count_statuses_filter
+     * @ticket 38843
      *
      * @param string $post_status New post status.
      * @param int    $change      Expected change.
      */
-    public function test_term_count_changes_for_post_statuses_with_attachments( $post_status, $change ) {
+    public function test_term_count_changes_for_update_post_term_count_statuses_filter( $post_status, $change ) {
         $term_count = get_term( self::$attachment_term )->count;
-        // Do not use shared fixture for this test as it relies on a new post.
+
+        add_filter( 'update_post_term_count_statuses', array( $this, 'add_custom_status_to_counted_statuses' ) );
+
         $post_id = $this->factory()->post->create( array( 'post_status' => $post_status ) );
         wp_add_object_terms( $post_id, self::$attachment_term, 'wp_test_tax_counts' );
@@ -250 +258 @@
         $expected = $term_count + $change;
         $this->assertSame( $expected, get_term( self::$attachment_term )->count );
-    }
-
-    /**
-     * Data provider for test_term_count_changes_for_post_statuses_with_attachments.
+
+        remove_filter( 'update_post_term_count_statuses', array( $this, 'add_custom_status_to_counted_statuses' ) );
+    }
+
+    /**
+     * Data provider for test_term_count_changes_for_update_post_term_count_statuses_filter.
      *
      * @return array[] {
@@ -260 +270 @@
      * }
      */
-    function data_term_count_changes_for_post_statuses_with_attachments() {
+    function data_term_count_changes_for_update_post_term_count_statuses_filter() {
         return array(
             // 0. Published post
@@ -270 +280 @@
             // 3. Private post
             array( 'private', 0 ),
+            // 4. Custom post status
+            array( 'custom', 2 ),
+        );
+    }
+
+    /**
+     * Term counts incremented correctly for posts with attachment.
+     *
+     * @covers ::wp_update_term_count
+     * @dataProvider data_term_count_changes_for_post_statuses_with_attachments
+     *
+     * @param string $post_status New post status.
+     * @param int    $change      Expected change.
+     */
+    public function test_term_count_changes_for_post_statuses_with_attachments( $post_status, $change ) {
+        $term_count = get_term( self::$attachment_term )->count;
+        // Do not use shared fixture for this test as it relies on a new post.
+        $post_id = $this->factory()->post->create( array( 'post_status' => $post_status ) );
+        wp_add_object_terms( $post_id, self::$attachment_term, 'wp_test_tax_counts' );
+        $attachment_id = self::factory()->attachment->create_object(
+            array(
+                'file'        => 'image.jpg',
+                'post_parent' => $post_id,
+                'post_status' => 'inherit',
+            )
+        );
+        wp_add_object_terms( $attachment_id, self::$attachment_term, 'wp_test_tax_counts' );
+
+        $expected = $term_count + $change;
+        $this->assertSame( $expected, get_term( self::$attachment_term )->count );
+    }
+
+    /**
+     * Data provider for test_term_count_changes_for_post_statuses_with_attachments.
+     *
+     * @return array[] {
+     *     @type string $post_status New post status.
+     *     @type int    $change      Expected change.
+     * }
+     */
+    function data_term_count_changes_for_post_statuses_with_attachments() {
+        return array(
+            // 0. Published post
+            array( 'publish', 2 ),
+            // 1. Auto draft
+            array( 'auto-draft', 0 ),
+            // 2. Draft
+            array( 'draft', 0 ),
+            // 3. Private post
+            array( 'private', 0 ),
         );
     }