Changeset 55406

Timestamp:

02/22/2023 08:47:38 PM (2 years ago)

Author:

johnbillion

Message:

Revisions: Remove an unnecessary call to _doing_it_wrong() and corresponding new text string from the implementation of the new wp_save_post_revision_revisions_before_deletion filter.

While the guard condition was technically correct, it's not practical or necessary to provide this protection for every use of every filter, and it adds unnecessary burden to translators to provide translations for strings that will likely not be seen.

Follow up to [55254].

Fixes #57320

Location:

trunk

Files:

• src/wp-includes/revision.php (modified) (1 diff)
• tests/phpunit/tests/post/revisions.php (modified) (1 diff)

trunk/src/wp-includes/revision.php

@@ -206 +206 @@
      * @since 6.2.0
      *
-     * @param WP_Post[]|int[] $revisions Array of revision objects or IDs,
-     *                                   or an empty array if none.
-     * @param int             $post_id   The ID of the post to save as a revision.
+     * @param WP_Post[] $revisions Array of revisions, or an empty array if none.
+     * @param int       $post_id   The ID of the post to save as a revision.
      */
-    $filtered_revisions = apply_filters(
+    $revisions = apply_filters(
         'wp_save_post_revision_revisions_before_deletion',
         $revisions,
         $post_id
     );
-
-    if ( is_array( $filtered_revisions ) ) {
-        $revisions = $filtered_revisions;
-    } else {
-        _doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                /* translators: %s: The filter name. */
-                __( 'The "%s" filter should return an array.' ),
-                'wp_save_post_revision_revisions_before_deletion'
-            ),
-            '6.2.0'
-        );
-    }
 
     $delete = count( $revisions ) - $revisions_to_keep;

trunk/tests/phpunit/tests/post/revisions.php

@@ -929 +929 @@
         );
     }
-
-    /**
-     * Tests that wp_save_post_revision() ignores an invalid return value
-     * from the 'wp_save_post_revision_revisions_before_deletion' filter
-     * and throws _doing_it_wrong().
-     *
-     * @ticket 57320
-     *
-     * @covers ::wp_save_post_revision
-     *
-     * @expectedIncorrectUsage wp_save_post_revision
-     */
-    public function test_wp_save_post_revision_should_ignore_invalid_revisions_before_deletion_filter() {
-        $post_id = self::factory()->post->create( array( 'post_title' => 'Test 57320' ) );
-
-        add_filter(
-            'wp_revisions_to_keep',
-            static function() {
-                return 1;
-            }
-        );
-
-        add_filter( 'wp_save_post_revision_revisions_before_deletion', '__return_null' );
-
-        for ( $update = 1; $update < 4; ++$update ) {
-            wp_update_post(
-                array(
-                    'ID'         => $post_id,
-                    'post_title' => 'Test 57320 Update ' . $update,
-                )
-            );
-        }
-
-        $actual = wp_get_post_revisions( $post_id );
-
-        $this->assertCount(
-            1,
-            $actual,
-            'There should only be one revision.'
-        );
-
-        $first = reset( $actual );
-
-        $this->assertSame(
-            'Test 57320 Update 3',
-            $first->post_title,
-            'The title of the first revision was incorrect.'
-        );
-    }
 }