Changeset 7234

Timestamp:

02/17/2022 08:04:32 PM (3 years ago)

Author:

johnjamesjacoby

Message:

Moderation: use the correct post_status when untrashing a topic/reply.

This change fixes a bug/regression (since WordPress 5.6.0) that was causing untrashed topics & replies to use an unintended post_status value.

It fixes it by adding a new function ('bbp_fix_untrash_post_status()') and hooking it to the wp_untrash_post_status filter in WordPress, and overriding the results as needed.

Props r-a-y.

In branches/2.6 for 2.6.10. Fixes #3433.

Location:

branches/2.6

Files:

• src/includes/common/functions.php (modified) (1 diff)
• src/includes/core/filters.php (modified) (1 diff)
• tests/phpunit/testcases/topics/functions/topic.php (modified) (1 diff)

branches/2.6/src/includes/common/functions.php

@@ -186 +186 @@
 
     return $data;
+}
+
+/**
+ * Use the previous status when restoring a topic or reply.
+ *
+ * Fixes an issue since WordPress 5.6.0. See
+ * {@link https://bbpress.trac.wordpress.org/ticket/3433}.
+ *
+ * @since 2.6.10 bbPress (r7233)
+ *
+ * @param string $new_status      New status to use when untrashing. Default: 'draft'
+ * @param int    $post_id         Post ID
+ * @param string $previous_status Previous post status from '_wp_trash_meta_status' meta key. Default: 'pending'
+ */
+function bbp_fix_untrash_post_status( $new_status = 'draft', $post_id = 0, $previous_status = 'pending' ) {
+
+    // Bail if not Topic or Reply
+    if ( ! bbp_is_topic( $post_id ) && ! bbp_is_reply( $post_id ) ) {
+        return $new_status;
+    }
+
+    // Prefer the previous status, falling back to the new status
+    $retval = ! empty( $previous_status )
+        ? $previous_status
+        : $new_status;
+
+    return $retval;
 }
 

branches/2.6/src/includes/core/filters.php

@@ -52 +52 @@
 // Fix post author id for anonymous posts (set it back to 0) when the post status is changed
 add_filter( 'wp_insert_post_data', 'bbp_fix_post_author', 30, 2 );
+
+// Fix untrash post status after a topic or reply is re-instated
+add_filter( 'wp_untrash_post_status', 'bbp_fix_untrash_post_status', 10, 3 );
 
 // Force comments_status on bbPress post types

branches/2.6/tests/phpunit/testcases/topics/functions/topic.php

@@ -424 +424 @@
     /**
      * @covers ::bbp_untrash_topic
-     * @todo   Implement test_bbp_untrash_topic().
      */
     public function test_bbp_untrash_topic() {
-        // Remove the following lines when you implement this test.
-        $this->markTestIncomplete(
-            'This test has not been implemented yet.'
-        );
+        $f = $this->factory->forum->create();
+        $t = $this->factory->topic->create( array(
+            'post_parent' => $f,
+            'topic_meta' => array(
+                'forum_id' => $f,
+            ),
+        ) );
+
+        wp_trash_post( $t );
+
+        wp_untrash_post( $t );
+
+        $this->assertTrue( 'publish' === get_post_status( $t ) );
     }
 
     /**
      * @covers ::bbp_untrash_topic_replies
-     * @todo   Implement test_bbp_untrash_topic_replies().
      */
     public function test_bbp_untrash_topic_replies() {
-        // Remove the following lines when you implement this test.
-        $this->markTestIncomplete(
-            'This test has not been implemented yet.'
-        );
+        $f = $this->factory->forum->create();
+        $t = $this->factory->topic->create( array(
+            'post_parent' => $f,
+            'topic_meta' => array(
+                'forum_id' => $f,
+            ),
+        ) );
+        $r = $this->factory->reply->create_many( 2, array(
+            'post_parent' => $t,
+            'reply_meta' => array(
+                'forum_id' => $f,
+                'topic_id' => $t,
+            ),
+        ) );
+
+        wp_trash_post( $t );
+
+        wp_untrash_post( $t );
+
+        $expected = [];
+        $expected[] = get_post_status( $r[0] );
+        $expected[] = get_post_status( $r[1] );
+
+        $this->assertSame( [ 'publish', 'publish' ], $expected );
     }