Changeset 58225 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php

Timestamp:

05/28/2024 12:38:28 PM (14 months ago)

Author:

swissspidy

Message:

REST API: Refactor global styles endpoints in REST API to register with post type.

Updated the global styles endpoints in the REST API to extend from existing posts and revisions controllers. This reduces duplicated code and inconsistencies. The revisions controller is now a subclass of the WP_REST_Revisions_Controller. Related redundant methods were removed and schema generation and collection parameters were adjusted to suit the global styles context. Updated permission checks, constructor, and collection parameters accordingly. This change allows for easy override of these classes using the register_post_type_args filter.

This reintroduces [57624] (reverted in [57628]) with improved backward compatibility and further enhancements.

Props ramonopoly, spacedmonkey, mukesh27, swissspidy.
Fixes #60131.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php (modified) (10 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php

@@ -11 +11 @@
  * Base Global Styles REST API Controller.
  */
-class WP_REST_Global_Styles_Controller extends WP_REST_Controller {
-
-    /**
-     * Post type.
-     *
-     * @since 5.9.0
-     * @var string
-     */
-    protected $post_type;
+class WP_REST_Global_Styles_Controller extends WP_REST_Posts_Controller {
+    /**
+     * Whether the controller supports batching.
+     *
+     * @since 6.6.0
+     * @var array
+     */
+    protected $allow_batch = array( 'v1' => false );
 
     /**
      * Constructor.
-     * @since 5.9.0
-     */
-    public function __construct() {
-        $this->namespace = 'wp/v2';
-        $this->rest_base = 'global-styles';
-        $this->post_type = 'wp_global_styles';
+     *
+     * @since 6.6.0
+     *
+     * @param string $post_type Post type.
+     */
+    public function __construct( $post_type = 'wp_global_styles' ) {
+        parent::__construct( $post_type );
     }
 
@@ -51 +51 @@
                         ),
                     ),
+                    'allow_batch'         => $this->allow_batch,
                 ),
             )
@@ -80 +81 @@
                         ),
                     ),
+                    'allow_batch'         => $this->allow_batch,
                 ),
             )
@@ -107 +109 @@
                     'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
                 ),
-                'schema' => array( $this, 'get_public_item_schema' ),
+                'schema'      => array( $this, 'get_public_item_schema' ),
+                'allow_batch' => $this->allow_batch,
             )
         );
@@ -195 +198 @@
      * @return bool Whether the post can be read.
      */
-    protected function check_read_permission( $post ) {
+    public function check_read_permission( $post ) {
         return current_user_can( 'read_post', $post->ID );
-    }
-
-    /**
-     * Returns the given global styles config.
-     *
-     * @since 5.9.0
-     *
-     * @param WP_REST_Request $request The request instance.
-     *
-     * @return WP_REST_Response|WP_Error
-     */
-    public function get_item( $request ) {
-        $post = $this->get_post( $request['id'] );
-        if ( is_wp_error( $post ) ) {
-            return $post;
-        }
-
-        return $this->prepare_item_for_response( $post, $request );
     }
 
@@ -240 +225 @@
 
         return true;
-    }
-
-    /**
-     * Checks if a global style can be edited.
-     *
-     * @since 5.9.0
-     *
-     * @param WP_Post $post Post object.
-     * @return bool Whether the post can be edited.
-     */
-    protected function check_update_permission( $post ) {
-        return current_user_can( 'edit_post', $post->ID );
-    }
-
-    /**
-     * Updates a single global style config.
-     *
-     * @since 5.9.0
-     *
-     * @param WP_REST_Request $request Full details about the request.
-     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
-     */
-    public function update_item( $request ) {
-        $post_before = $this->get_post( $request['id'] );
-        if ( is_wp_error( $post_before ) ) {
-            return $post_before;
-        }
-
-        $changes = $this->prepare_item_for_database( $request );
-        if ( is_wp_error( $changes ) ) {
-            return $changes;
-        }
-
-        $result = wp_update_post( wp_slash( (array) $changes ), true, false );
-        if ( is_wp_error( $result ) ) {
-            return $result;
-        }
-
-        $post          = get_post( $request['id'] );
-        $fields_update = $this->update_additional_fields_for_object( $post, $request );
-        if ( is_wp_error( $fields_update ) ) {
-            return $fields_update;
-        }
-
-        wp_after_insert_post( $post, true, $post_before );
-
-        $response = $this->prepare_item_for_response( $post, $request );
-
-        return rest_ensure_response( $response );
     }
 
@@ -408 +344 @@
             $response->add_links( $links );
             if ( ! empty( $links['self']['href'] ) ) {
-                $actions = $this->get_available_actions();
+                $actions = $this->get_available_actions( $post, $request );
                 $self    = $links['self']['href'];
                 foreach ( $actions as $rel ) {
@@ -432 +368 @@
 
         $links = array(
-            'self' => array(
+            'self'  => array(
                 'href' => rest_url( trailingslashit( $base ) . $id ),
+            ),
+            'about' => array(
+                'href' => rest_url( 'wp/v2/types/' . $this->post_type ),
             ),
         );
@@ -455 +394 @@
      * @since 5.9.0
      * @since 6.2.0 Added 'edit-css' action.
-     *
+     * @since 6.6.0 Added $post and $request parameters.
+     *
+     * @param WP_Post         $post    Post object.
+     * @param WP_REST_Request $request Request object.
      * @return array List of link relations.
      */
-    protected function get_available_actions() {
+    protected function get_available_actions( $post, $request ) {
         $rels = array();
 
-        $post_type = get_post_type_object( $this->post_type );
+        $post_type = get_post_type_object( $post->post_type );
         if ( current_user_can( $post_type->cap->publish_posts ) ) {
             $rels[] = 'https://api.w.org/action-publish';
@@ -471 +413 @@
 
         return $rels;
-    }
-
-    /**
-     * Overwrites the default protected title format.
-     *
-     * By default, WordPress will show password protected posts with a title of
-     * "Protected: %s", as the REST API communicates the protected status of a post
-     * in a machine readable format, we remove the "Protected: " prefix.
-     *
-     * @since 5.9.0
-     *
-     * @return string Protected title format.
-     */
-    public function protected_title_format() {
-        return '%s';
     }