Changeset 56819 for trunk/src/wp-includes/class-wp-post-type.php

Timestamp:

10/10/2023 02:03:03 PM (20 months ago)

Author:

spacedmonkey

Message:

REST API: Fix issue with Template and Template Part Revision/Autosave REST API controllers.

The Template and Template Part REST API controllers have unique characteristics compared to other post type REST API controllers. They do not rely on integer IDs to reference objects; instead, they use a combination of the theme name and slug of the template, like 'twentytwentyfourhome.' Consequently, when the post types template and template part were introduced in [52062], it led to the registration of REST API endpoints for autosaves and revisions with invalid URL structures.

In this commit, we introduce new functionality to enable custom autosave and revisions endpoints to be registered at the post type level. Similar to the 'rest_controller_class' parameter, developers can now define 'revisions_rest_controller' and 'autosave_rest_controller.' This empowers developers to create custom controllers for these functionalities. Additionally, we introduce a 'late_route_registration' parameter, which proves helpful when dealing with custom URL patterns and regex pattern matching issues.
This commit registers new classes for template and template part autosave and revisions controllers, differentiating them from standard controllers in the following ways:

• The response shape now matches that of the template controller.
• Permission checks align with the template controller.
• A custom URL pattern is introduced to support slug-based identification of templates.

Furthermore, we've updated the utility function '_build_block_template_result_from_post' to support passing revision post objects. This enhancement ensures compatibility with the custom revisions controller.

Props spacedmonkey, revgeorge, andraganescu, hellofromTonya, antonvlasenko, kadamwhite, ironprogrammer, costdev, mukesh27, timothyblynjacobs, adamsilverstein.
Fixes 56922.

File:

• trunk/src/wp-includes/class-wp-post-type.php (modified) (4 diffs)

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

@@ -396 +396 @@
      */
     public $rest_controller;
+
+    /**
+     * The controller for this post type's revisions REST API endpoints.
+     *
+     * Custom controllers must extend WP_REST_Controller.
+     *
+     * @since 6.4.0
+     * @var string|bool $revisions_rest_controller_class
+     */
+    public $revisions_rest_controller_class;
+
+    /**
+     * The controller instance for this post type's revisions REST API endpoints.
+     *
+     * Lazily computed. Should be accessed using {@see WP_Post_Type::get_revisions_rest_controller()}.
+     *
+     * @since 6.4.0
+     * @var WP_REST_Controller $revisions_rest_controller
+     */
+    public $revisions_rest_controller;
+
+    /**
+     * The controller for this post type's autosave REST API endpoints.
+     *
+     * Custom controllers must extend WP_REST_Controller.
+     *
+     * @since 6.4.0
+     * @var string|bool $autosave_rest_controller_class
+     */
+    public $autosave_rest_controller_class;
+
+    /**
+     * The controller instance for this post type's autosave REST API endpoints.
+     *
+     * Lazily computed. Should be accessed using {@see WP_Post_Type::get_autosave_rest_controller()}.
+     *
+     * @since 6.4.0
+     * @var WP_REST_Controller $autosave_rest_controller
+     */
+    public $autosave_rest_controller;
+
+    /**
+     * A flag to register the post type REST API controller after its associated autosave / revisions controllers, instead of before. Registration order affects route matching priority.
+     *
+     * @since 6.4.0
+     * @var bool $late_route_registration
+     */
+    public $late_route_registration;
 
     /**
@@ -456 +504 @@
          *
          * @since 6.0.0
+         * @since 6.4.0 Added `late_route_registration`, `autosave_rest_controller_class` and `revisions_rest_controller_class` arguments.
          *
          * @param array  $args      Array of arguments for registering a post type.
@@ -467 +516 @@
         // Args prefixed with an underscore are reserved for internal use.
         $defaults = array(
-            'labels'                => array(),
-            'description'           => '',
-            'public'                => false,
-            'hierarchical'          => false,
-            'exclude_from_search'   => null,
-            'publicly_queryable'    => null,
-            'show_ui'               => null,
-            'show_in_menu'          => null,
-            'show_in_nav_menus'     => null,
-            'show_in_admin_bar'     => null,
-            'menu_position'         => null,
-            'menu_icon'             => null,
-            'capability_type'       => 'post',
-            'capabilities'          => array(),
-            'map_meta_cap'          => null,
-            'supports'              => array(),
-            'register_meta_box_cb'  => null,
-            'taxonomies'            => array(),
-            'has_archive'           => false,
-            'rewrite'               => true,
-            'query_var'             => true,
-            'can_export'            => true,
-            'delete_with_user'      => null,
-            'show_in_rest'          => false,
-            'rest_base'             => false,
-            'rest_namespace'        => false,
-            'rest_controller_class' => false,
-            'template'              => array(),
-            'template_lock'         => false,
-            '_builtin'              => false,
-            '_edit_link'            => 'post.php?post=%d',
+            'labels'                          => array(),
+            'description'                     => '',
+            'public'                          => false,
+            'hierarchical'                    => false,
+            'exclude_from_search'             => null,
+            'publicly_queryable'              => null,
+            'show_ui'                         => null,
+            'show_in_menu'                    => null,
+            'show_in_nav_menus'               => null,
+            'show_in_admin_bar'               => null,
+            'menu_position'                   => null,
+            'menu_icon'                       => null,
+            'capability_type'                 => 'post',
+            'capabilities'                    => array(),
+            'map_meta_cap'                    => null,
+            'supports'                        => array(),
+            'register_meta_box_cb'            => null,
+            'taxonomies'                      => array(),
+            'has_archive'                     => false,
+            'rewrite'                         => true,
+            'query_var'                       => true,
+            'can_export'                      => true,
+            'delete_with_user'                => null,
+            'show_in_rest'                    => false,
+            'rest_base'                       => false,
+            'rest_namespace'                  => false,
+            'rest_controller_class'           => false,
+            'autosave_rest_controller_class'  => false,
+            'revisions_rest_controller_class' => false,
+            'late_route_registration'         => false,
+            'template'                        => array(),
+            'template_lock'                   => false,
+            '_builtin'                        => false,
+            '_edit_link'                      => 'post.php?post=%d',
         );
 
@@ -815 +867 @@
 
         return $this->rest_controller;
+    }
+
+    /**
+     * Gets the REST API revisions controller for this post type.
+     *
+     * Will only instantiate the controller class once per request.
+     *
+     * @since 6.4.0
+     *
+     * @return WP_REST_Controller|null The controller instance, or null if the post type
+     *                                 is set not to show in rest.
+     */
+    public function get_revisions_rest_controller() {
+        if ( ! $this->show_in_rest ) {
+            return null;
+        }
+
+        if ( ! post_type_supports( $this->name, 'revisions' ) ) {
+            return null;
+        }
+
+        $class = $this->revisions_rest_controller_class ? $this->revisions_rest_controller_class : WP_REST_Revisions_Controller::class;
+        if ( ! class_exists( $class ) ) {
+            return null;
+        }
+
+        if ( ! is_subclass_of( $class, WP_REST_Controller::class ) ) {
+            return null;
+        }
+
+        if ( ! $this->revisions_rest_controller ) {
+            $this->revisions_rest_controller = new $class( $this->name );
+        }
+
+        if ( ! ( $this->revisions_rest_controller instanceof $class ) ) {
+            return null;
+        }
+
+        return $this->revisions_rest_controller;
+    }
+
+    /**
+     * Gets the REST API autosave controller for this post type.
+     *
+     * Will only instantiate the controller class once per request.
+     *
+     * @since 6.4.0
+     *
+     * @return WP_REST_Controller|null The controller instance, or null if the post type
+     *                                 is set not to show in rest.
+     */
+    public function get_autosave_rest_controller() {
+        if ( ! $this->show_in_rest ) {
+            return null;
+        }
+
+        if ( 'attachment' === $this->name ) {
+            return null;
+        }
+
+        $class = $this->autosave_rest_controller_class ? $this->autosave_rest_controller_class : WP_REST_Autosaves_Controller::class;
+
+        if ( ! class_exists( $class ) ) {
+            return null;
+        }
+
+        if ( ! is_subclass_of( $class, WP_REST_Controller::class ) ) {
+            return null;
+        }
+
+        if ( ! $this->autosave_rest_controller ) {
+            $this->autosave_rest_controller = new $class( $this->name );
+        }
+
+        if ( ! ( $this->autosave_rest_controller instanceof $class ) ) {
+            return null;
+        }
+
+        return $this->autosave_rest_controller;
     }