Ticket #2813: 2813.02.patch

src/includes/core/actions.php

@@ -340 +340 @@
 add_action( 'bbp_new_reply_post_extras', 'bbp_clean_post_cache' );
 
 // Clean bbPress post caches when WordPress's is cleaned
-add_action( 'clean_post_cache', 'bbp_clean_post_cache' );
+add_action( 'clean_post_cache', 'bbp_clean_post_cache', 10, 2 );
 
 /**
  * bbPress needs to redirect the user around in a few different circumstances:

src/includes/core/cache.php

@@ -131 +131 @@
  *
  * @since 2.1.0 bbPress (r4040)
  *
+ * @param int     $post_id The post id.
+ * @param WP_Post $post    The WP_Post object.
+ *
+ * @uses get_post() To get the post object.
+ * @uses bbp_get_forum_post_type() To get the forum post type.
+ * @uses bbp_get_topic_post_type() To get the topic post type.
+ * @uses bbp_get_reply_post_type() To get the reply post type.
+ * @uses wp_cache_delete() To delete the cache item.
+ * @uses clean_object_term_cache() To clean the term cache.
+ * @uses bbp_clean_post_cache() Recursion.
  * @uses do_action() Calls 'bbp_clean_post_cache' on $id
- * @param object|int $_post The post object or ID to remove from the cache
+ *
+ * @return void
  */
-function bbp_clean_post_cache( $_post = '' ) {
+function bbp_clean_post_cache( $post_id = null, $post = null ) {
 
-        // Bail if no post
-        $_post = get_post( $_post );
-        if ( empty( $_post ) ) {
+        // Get the post object.
+        if ( null !== $post ) {
+                $post = get_post( $post );
+        } else {
+                $post = get_post( $post_id );
+        }
+
+        // Bail if no post.
+        if ( empty( $post ) ) {
                 return;
         }
 
-        // Child query types to clean
+        // Child query types to clean.
         $post_types = array(
                 bbp_get_forum_post_type(),
                 bbp_get_topic_post_type(),
-                bbp_get_reply_post_type()
+                bbp_get_reply_post_type(),
         );
 
-        // Bail if not a bbPress post type
-        if ( ! in_array( $_post->post_type, $post_types, true ) ) {
+        // Bail if not a bbPress post type.
+        if ( ! in_array( $post->post_type, $post_types, true ) ) {
                 return;
         }
 
-        wp_cache_delete( $_post->ID, 'posts'     );
-        wp_cache_delete( $_post->ID, 'post_meta' );
-
-        clean_object_term_cache( $_post->ID, $_post->post_type );
+        // Be sure we haven't recached the post data.
+        wp_cache_delete( $post->ID, 'posts'     );
+        wp_cache_delete( $post->ID, 'post_meta' );
 
-        do_action( 'bbp_clean_post_cache', $_post->ID, $_post );
+        // Clean the term cache for the given post.
+        clean_object_term_cache( $post->ID, $post->post_type );
 
-        // Loop through query types and clean caches
+        // Loop through query types and clean caches.
         foreach ( $post_types as $post_type ) {
-                wp_cache_delete( 'bbp_parent_all_'    . $_post->ID . '_type_' . $post_type . '_child_ids',     'bbpress_posts' );
+                wp_cache_delete( 'bbp_parent_all_'    . $post->ID . '_type_' . $post_type . '_child_ids',     'bbpress_posts' );
         }
 
-        // Invalidate parent caches
-        if ( ! empty( $_post->post_parent ) ) {
-                bbp_clean_post_cache( $_post->post_parent );
+        /**
+         * Fires immediately after the given post's cache is cleaned.
+         *
+         * @since 2.1.0
+         *
+         * @param int     $post_id Post ID.
+         * @param WP_Post $post    Post object.
+         */
+        do_action( 'bbp_clean_post_cache', $post->ID, $post );
+
+        // Invalidate parent caches.
+        if ( ! empty( $post->post_parent ) ) {
+                bbp_clean_post_cache( $post->post_parent );
         }
 }

new file tests/phpunit/testcases/core/cache.php

@@ +1 @@
+<?php
+
+/**
+ * @group cache
+ */
+class BBP_Core_Cache_Tests extends BBP_UnitTestCase {
+
+        /**
+         * @covers ::bbp_clean_post_cache
+         */
+        public function test_bbp_clean_post_cache() {
+
+                // Get the topic post type.
+                $tpt = bbp_get_topic_post_type();
+
+                // Set up a forum with 1 topic and 1 reply to that topic.
+                $f = $this->factory->forum->create();
+                $t = $this->factory->topic->create( array(
+                        'post_parent' => $f,
+                        'topic_meta' => array(
+                                'forum_id' => $f,
+                        ),
+                ) );
+                $r = $this->factory->topic->create( array(
+                        'post_parent' => $t,
+                        'reply_meta' => array(
+                                'forum_id' => $f,
+                                'topic_id' => $t,
+                        ),
+                ) );
+
+                // Make sure we've cached some data.
+                bbp_get_all_child_ids( $f, $tpt );
+                bbp_get_all_child_ids( $t, $tpt );
+
+                $this->assertEquals( array( $t ), wp_cache_get( "bbp_parent_all_{$f}_type_{$tpt}_child_ids", 'bbpress_posts' ) );
+                $this->assertEquals( array( $r ), wp_cache_get( "bbp_parent_all_{$t}_type_{$tpt}_child_ids", 'bbpress_posts' ) );
+
+                // Clean the cache.
+                bbp_clean_post_cache( $r );
+
+                $this->assertEquals( false, wp_cache_get( "bbp_parent_all_{$f}_type_{$tpt}_child_ids", 'bbpress_posts' ) );
+                $this->assertEquals( false, wp_cache_get( "bbp_parent_all_{$t}_type_{$tpt}_child_ids", 'bbpress_posts' ) );
+        }
+}