Changeset 54269 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

Timestamp:

09/20/2022 09:19:10 PM (15 months ago)

Author:

hellofromTonya

Message:

Editor: Adds template types, is_wp_suggestion, and fallback template content.

This commit improves site editor templates by:

• Adds a post meta is_wp_suggestion to templates created from the site editor.

Why? To differentiate the templates created from the post editor in the Template panel in inspector controls and the templates suggested in site editor.

See ​Gutenberg PR 41387 for more details.

• Expands the template types that can be added to the site editor to include single custom post type and specific posts templates.

See ​Gutenberg PR 41189 for more details.

• Adds fallback template content on creation in site editor:
  • Introduces get_template_hierarchy() to get the template hierarchy for a given template slug to be created.
  • Adds a lookup route to WP_REST_Templates_Controller to get the fallback template content.

See ​Gutenberg PR 42520 for more details.

• Fixes a typo in default category template's description within get_default_block_template_types().

See ​Gutenberg PR 42586 for more details.

• Changes field checks from in_array() to rest_is_field_included() in WP_REST_Post_Types_Controller.
• Adds an icon field to WP_REST_Post_Types_Controller

Follow-up to [53129], [52331], [52275], [52062], [51962], [43087].

Props ntsekouras, spacedmonkey, mamaduka, mburridge, jameskoster, bernhard-reiter, mcsf, hellofromTonya.
See #56467.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php (modified) (4 diffs)

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

@@ -43 +43 @@
      *
      * @since 5.8.0
+     * @since 6.1.0 Endpoint for fallback template content.
      */
     public function register_routes() {
@@ -63 +64 @@
                 ),
                 'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        );
+
+        // Get fallback template content.
+        register_rest_route(
+            $this->namespace,
+            '/' . $this->rest_base . '/lookup',
+            array(
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_template_fallback' ),
+                    'permission_callback' => array( $this, 'get_item_permissions_check' ),
+                    'args'                => array(
+                        'slug'            => array(
+                            'description' => __( 'The slug of the template to get the fallback for' ),
+                            'type'        => 'string',
+                            'required'    => true,
+                        ),
+                        'is_custom'       => array(
+                            'description' => __( ' Indicates if a template is custom or part of the template hierarchy' ),
+                            'type'        => 'boolean',
+                        ),
+                        'template_prefix' => array(
+                            'description' => __( 'The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`' ),
+                            'type'        => 'string',
+                        ),
+                    ),
+                ),
             )
         );
@@ -116 +145 @@
             )
         );
+    }
+
+    /**
+     * Returns the fallback template for the given slug.
+     *
+     * @since 6.1.0
+     *
+     * @param WP_REST_Request $request The request instance.
+     * @return WP_REST_Response|WP_Error
+     */
+    public function get_template_fallback( $request ) {
+        $hierarchy         = get_template_hierarchy( $request['slug'], $request['is_custom'], $request['template_prefix'] );
+        $fallback_template = resolve_block_template( $request['slug'], $hierarchy, '' );
+        $response          = $this->prepare_item_for_response( $fallback_template, $request );
+        return rest_ensure_response( $response );
     }
 
@@ -526 +570 @@
         }
 
+        if ( 'wp_template' === $this->post_type && isset( $request['is_wp_suggestion'] ) ) {
+            $changes->meta_input     = wp_parse_args(
+                array(
+                    'is_wp_suggestion' => $request['is_wp_suggestion'],
+                ),
+                $changes->meta_input = array()
+            );
+        }
+
         if ( 'wp_template_part' === $this->post_type ) {
             if ( isset( $request['area'] ) ) {