Changeset 58201

Timestamp:

05/27/2024 09:04:10 AM (8 months ago)

Author:

swissspidy

Message:

Posts, Post Types: Autosave: Allow disabling autosave support per post type.

Not all post types support autosaving. By making autosave a post type feature, support can be more granularly handled without any workarounds or hardcoded allowlists. wp_font_family and wp_font_face are examples of built-in post types which do not support autosave.

For backward compatibility reasons, adding editor support implies autosave support, so one would need to explicitly use remove_post_type_support() to remove it again.

Props swissspidy, youknowriad, hellofromtonya, peterwilsoncc.
Fixes #41172.

Location:

trunk

Files:

• src/wp-includes/class-wp-post-type.php (modified) (2 diffs)
• src/wp-includes/post.php (modified) (6 diffs)
• tests/phpunit/tests/fonts/font-library/postTypes.php (added)
• tests/phpunit/tests/post/types.php (modified) (3 diffs)
• tests/phpunit/tests/post/wpPostType.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-post-type.php

@@ -671 +671 @@
             }
             unset( $this->supports );
+
+            /*
+             * 'editor' support implies 'autosave' support for backward compatibility.
+             * 'autosave' support needs to be explicitly removed if not desired.
+             */
+            if (
+                post_type_supports( $this->name, 'editor' ) &&
+                ! post_type_supports( $this->name, 'autosave' )
+            ) {
+                add_post_type_support( $this->name, 'autosave' );
+            }
         } elseif ( false !== $this->supports ) {
             // Add default features.
-            add_post_type_support( $this->name, array( 'title', 'editor' ) );
+            add_post_type_support( $this->name, array( 'title', 'editor', 'autosave' ) );
         }
     }
@@ -920 +931 @@
     public function get_autosave_rest_controller() {
         if ( ! $this->show_in_rest ) {
+            return null;
+        }
+
+        if ( ! post_type_supports( $this->name, 'autosave' ) ) {
             return null;
         }

trunk/src/wp-includes/post.php

@@ -571 +571 @@
         'wp_font_family',
         array(
-            'labels'                         => array(
+            'labels'                => array(
                 'name'          => __( 'Font Families' ),
                 'singular_name' => __( 'Font Family' ),
             ),
-            'public'                         => false,
-            '_builtin'                       => true, /* internal use only. don't use this when registering your own post type. */
-            'hierarchical'                   => false,
-            'capabilities'                   => array(
+            'public'                => false,
+            '_builtin'              => true, /* internal use only. don't use this when registering your own post type. */
+            'hierarchical'          => false,
+            'capabilities'          => array(
                 'read'                   => 'edit_theme_options',
                 'read_private_posts'     => 'edit_theme_options',
@@ -590 +590 @@
                 'delete_published_posts' => 'edit_theme_options',
             ),
-            'map_meta_cap'                   => true,
-            'query_var'                      => false,
-            'rewrite'                        => false,
-            'show_in_rest'                   => true,
-            'rest_base'                      => 'font-families',
-            'rest_controller_class'          => 'WP_REST_Font_Families_Controller',
-            // Disable autosave endpoints for font families.
-            'autosave_rest_controller_class' => 'stdClass',
+            'map_meta_cap'          => true,
+            'query_var'             => false,
+            'rewrite'               => false,
+            'show_in_rest'          => true,
+            'rest_base'             => 'font-families',
+            'rest_controller_class' => 'WP_REST_Font_Families_Controller',
+            'supports'              => array( 'title' ),
         )
     );
@@ -604 +603 @@
         'wp_font_face',
         array(
-            'labels'                         => array(
+            'labels'                => array(
                 'name'          => __( 'Font Faces' ),
                 'singular_name' => __( 'Font Face' ),
             ),
-            'public'                         => false,
-            '_builtin'                       => true, /* internal use only. don't use this when registering your own post type. */
-            'hierarchical'                   => false,
-            'capabilities'                   => array(
+            'public'                => false,
+            '_builtin'              => true, /* internal use only. don't use this when registering your own post type. */
+            'hierarchical'          => false,
+            'capabilities'          => array(
                 'read'                   => 'edit_theme_options',
                 'read_private_posts'     => 'edit_theme_options',
@@ -623 +622 @@
                 'delete_published_posts' => 'edit_theme_options',
             ),
-            'map_meta_cap'                   => true,
-            'query_var'                      => false,
-            'rewrite'                        => false,
-            'show_in_rest'                   => true,
-            'rest_base'                      => 'font-families/(?P<font_family_id>[\d]+)/font-faces',
-            'rest_controller_class'          => 'WP_REST_Font_Faces_Controller',
-            // Disable autosave endpoints for font faces.
-            'autosave_rest_controller_class' => 'stdClass',
+            'map_meta_cap'          => true,
+            'query_var'             => false,
+            'rewrite'               => false,
+            'show_in_rest'          => true,
+            'rest_base'             => 'font-families/(?P<font_family_id>[\d]+)/font-faces',
+            'rest_controller_class' => 'WP_REST_Font_Faces_Controller',
+            'supports'              => array( 'title' ),
         )
     );
@@ -1720 +1718 @@
  *                                                         'page-attributes', 'thumbnail', 'custom-fields', and 'post-formats'.
  *                                                         Additionally, the 'revisions' feature dictates whether the post type
- *                                                         will store revisions, and the 'comments' feature dictates whether the
- *                                                         comments count will show on the edit screen. A feature can also be
+ *                                                         will store revisions, the 'autosave' feature dictates whether the post type
+ *                                                         will be autosaved, and the 'comments' feature dictates whether the
+ *                                                         comments count will show on the edit screen. For backward compatibility reasons,
+ *                                                         adding 'editor' support implies 'autosave' support too. A feature can also be
  *                                                         specified as an array of arguments to provide additional information
  *                                                         about supporting that feature.
@@ -2199 +2199 @@
  *
  * Additionally, the 'revisions' feature dictates whether the post type will
- * store revisions, and the 'comments' feature dictates whether the comments
+ * store revisions, the 'autosave' feature dictates whether the post type
+ * will be autosaved, and the 'comments' feature dictates whether the comments
  * count will show on the edit screen.
  *

trunk/tests/phpunit/tests/post/types.php

@@ -218 +218 @@
     /**
      * @ticket 21586
+     * @ticket 41172
      */
     public function test_post_type_with_no_support() {
         register_post_type( 'foo', array( 'supports' => array() ) );
-        $this->assertTrue( post_type_supports( 'foo', 'editor' ) );
-        $this->assertTrue( post_type_supports( 'foo', 'title' ) );
+        $this->assertTrue( post_type_supports( 'foo', 'editor' ), 'Editor support should be enabled by default.' );
+        $this->assertTrue( post_type_supports( 'foo', 'title' ), 'Title support should be enabled by default.' );
+        $this->assertTrue( post_type_supports( 'foo', 'autosave' ), 'Autosaves support should be enabled by default.' );
         _unregister_post_type( 'foo' );
 
         register_post_type( 'foo', array( 'supports' => false ) );
-        $this->assertFalse( post_type_supports( 'foo', 'editor' ) );
-        $this->assertFalse( post_type_supports( 'foo', 'title' ) );
+        $this->assertFalse( post_type_supports( 'foo', 'editor' ), 'Editor support should be disabled.' );
+        $this->assertFalse( post_type_supports( 'foo', 'title' ), 'Title support should be disabled.' );
+        $this->assertFalse( post_type_supports( 'foo', 'autosave' ), 'Autosaves support should be disabled.' );
         _unregister_post_type( 'foo' );
     }
@@ -433 +436 @@
         $this->assertSameSetsWithIndex(
             array(
-                'editor' => true,
-                'author' => true,
-                'title'  => true,
+                'editor'   => true,
+                'author'   => true,
+                'title'    => true,
+                'autosave' => true,
             ),
             $_wp_post_type_features['foo']
@@ -590 +594 @@
         $this->assertSameSets( array(), get_post_types_by_support( 'somefeature' ) );
     }
+
+    /**
+     * @ticket 41172
+     */
+    public function test_post_type_supports_autosave_based_on_editor_support() {
+        register_post_type( 'foo', array( 'supports' => array( 'editor' ) ) );
+        $this->assertTrue( post_type_supports( 'foo', 'autosave' ) );
+        _unregister_post_type( 'foo' );
+
+        register_post_type( 'foo', array( 'supports' => array( 'title' ) ) );
+        $this->assertFalse( post_type_supports( 'foo', 'autosave' ) );
+        _unregister_post_type( 'foo' );
+    }
+
+    /**
+     * @ticket 41172
+     */
+    public function test_removing_autosave_support_removes_rest_api_controller() {
+        register_post_type(
+            'foo',
+            array(
+                'show_in_rest' => true,
+                'supports'     => array( 'editor' ),
+            )
+        );
+
+        $post_type_object = get_post_type_object( 'foo' );
+        $this->assertInstanceOf( 'WP_REST_Autosaves_Controller', $post_type_object->get_autosave_rest_controller(), 'Autosave controller should be set by default.' );
+
+        remove_post_type_support( 'foo', 'autosave' );
+        $post_type_object = get_post_type_object( 'foo' );
+        $this->assertSame( null, $post_type_object->get_autosave_rest_controller(), 'Autosave controller should be removed.' );
+        _unregister_post_type( 'foo' );
+    }
+
+    /**
+     * @ticket 41172
+     */
+    public function test_removing_editor_support_does_not_remove_autosave_support() {
+        register_post_type(
+            'foo',
+            array(
+                'show_in_rest' => true,
+                'supports'     => array( 'editor' ),
+            )
+        );
+        remove_post_type_support( 'foo', 'editor' );
+
+        $this->assertFalse( post_type_supports( 'foo', 'editor' ), 'Post type should not support editor.' );
+        $this->assertTrue( post_type_supports( 'foo', 'autosave' ), 'Post type should still support autosaves.' );
+    }
 }

trunk/tests/phpunit/tests/post/wpPostType.php

@@ -25 +25 @@
         $this->assertSameSets(
             array(
-                'title'  => true,
-                'editor' => true,
+                'title'    => true,
+                'editor'   => true,
+                'autosave' => true,
             ),
             $post_type_supports
@@ -57 +58 @@
                 'comments'  => true,
                 'revisions' => true,
+                'autosave'  => true,
             ),
             $post_type_supports