Changeset 50949

Timestamp:

05/21/2021 03:28:39 PM (5 years ago)

Author:

adamsilverstein

Message:

Revisions: add a new filter for revisions to keep by post type.

Add a new wp_{$post_type}_revisions_to_keep filter that makes it convenient to filter the number of revisions created for a specific post type.

Overrides both the value of WP_POST_REVISIONS and the wp_revisions_to_keep filter.

Props dlh.
Fixes #51550.

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

@@ -565 +565 @@
          * @param WP_Post $post Post object.
          */
-        return (int) apply_filters( 'wp_revisions_to_keep', $num, $post );
+        $num = apply_filters( 'wp_revisions_to_keep', $num, $post );
+
+        /**
+         * Filters the number of revisions to save for the given post by its post type.
+         *
+         * Overrides both the value of WP_POST_REVISIONS and the {@see 'wp_revisions_to_keep'} filter.
+         *
+         * The dynamic portion of the hook name, `$post->post_type`, refers to
+         * the post type slug.
+         *
+         * @since 5.8.0
+         *
+         * @param int     $num  Number of revisions to store.
+         * @param WP_Post $post Post object.
+         */
+        $num = apply_filters( "wp_{$post->post_type}_revisions_to_keep", $num, $post );
+
+        return (int) $num;
 }
 

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

@@ -577 +577 @@
                 $this->assertSame( $revision_ids, array_values( wp_list_pluck( $revisions, 'ID' ) ) );
         }
+
+        /*
+         * @ticket 51550
+         */
+        public function test_wp_revisions_to_keep_filter() {
+                $post = self::factory()->post->create_and_get(
+                        array(
+                                'post_title'   => 'some-post',
+                                'post_type'    => 'post',
+                                'post_content' => 'some_content',
+                        )
+                );
+
+                $default  = wp_revisions_to_keep( $post );
+                $expected = $default + 1;
+
+                add_filter(
+                        'wp_revisions_to_keep',
+                        function () use ( $expected ) {
+                                return $expected;
+                        }
+                );
+
+                $this->assertSame( $expected, wp_revisions_to_keep( $post ) );
+        }
+
+        /*
+         * @ticket 51550
+         */
+        public function test_wp_post_type_revisions_to_keep_filter() {
+                $post = self::factory()->post->create_and_get(
+                        array(
+                                'post_title'   => 'some-post',
+                                'post_type'    => 'post',
+                                'post_content' => 'some_content',
+                        )
+                );
+
+                $default = wp_revisions_to_keep( $post );
+                $generic = $default + 1;
+
+                add_filter(
+                        'wp_revisions_to_keep',
+                        function () use ( $generic ) {
+                                return $generic;
+                        }
+                );
+                $this->assertSame( $generic, wp_revisions_to_keep( $post ) );
+
+                $expected = $generic + 1;
+
+                add_filter(
+                        "wp_{$post->post_type}_revisions_to_keep",
+                        function () use ( $expected ) {
+                                return $expected;
+                        }
+                );
+                $this->assertSame( $expected, wp_revisions_to_keep( $post ) );
+        }
 }