Changeset 58452

Timestamp:

06/21/2024 01:04:47 PM (10 months ago)

Author:

jorgefilipecosta

Message:

REST API: Add template and template_lock to post types endpoint.

Adds template and template_lock property of the post type to post types REST API endpoint.
This change allows us to fix a bug where the template of a page is not respected when creating a new page on the site editor.

Props jorgefilipecosta, oandregal, timothyblynjacobs, mukesh27.
Fixes #61477.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-post-types-controller.php (modified) (4 diffs)
• tests/qunit/fixtures/wp-api-generated.js (modified) (12 diffs)

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

@@ -245 +245 @@
         if ( rest_is_field_included( 'rest_namespace', $fields ) ) {
             $data['rest_namespace'] = $namespace;
+        }
+
+        if ( rest_is_field_included( 'template', $fields ) ) {
+            $data['template'] = $post_type->template ?? array();
+        }
+
+        if ( rest_is_field_included( 'template_lock', $fields ) ) {
+            $data['template_lock'] = ! empty( $post_type->template_lock ) ? $post_type->template_lock : false;
         }
 
@@ -408 +416 @@
                     'readonly'    => true,
                 ),
+                'template'       => array(
+                    'type'        => array( 'array' ),
+                    'description' => __( 'The block template associated with the post type.' ),
+                    'readonly'    => true,
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
+                'template_lock'  => array(
+                    'type'        => array( 'string', 'boolean' ),
+                    'enum'        => array( 'all', 'insert', 'contentOnly', false ),
+                    'description' => __( 'The template_lock associated with the post type, or false if none.' ),
+                    'readonly'    => true,
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
             ),
         );

trunk/tests/phpunit/tests/rest-api/rest-post-types-controller.php

@@ -78 +78 @@
     }
 
+    /**
+     * @ticket 61477
+     */
+    public function test_get_item_template_cpt() {
+        register_post_type(
+            'cpt_template',
+            array(
+                'show_in_rest'   => true,
+                'rest_base'      => 'cpt_template',
+                'rest_namespace' => 'wordpress/v1',
+                'template'       => array(
+                    array( 'core/paragraph', array( 'placeholder' => 'Content' ) ),
+                ),
+                'template_lock'  => 'all',
+            )
+        );
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/types/cpt_template' );
+        $response = rest_get_server()->dispatch( $request );
+        $this->check_post_type_object_response( 'view', $response, 'cpt_template' );
+    }
+
     public function test_get_item_page() {
         $request  = new WP_REST_Request( 'GET', '/wp/v2/types/page' );
@@ -166 +187 @@
         $properties = $data['schema']['properties'];
 
-        $this->assertCount( 14, $properties, 'Schema should have 14 properties' );
+        $this->assertCount( 16, $properties, 'Schema should have 16 properties' );
         $this->assertArrayHasKey( 'capabilities', $properties, '`capabilities` should be included in the schema' );
         $this->assertArrayHasKey( 'description', $properties, '`description` should be included in the schema' );
@@ -181 +202 @@
         $this->assertArrayHasKey( 'visibility', $properties, '`visibility` should be included in the schema' );
         $this->assertArrayHasKey( 'icon', $properties, '`icon` should be included in the schema' );
+        $this->assertArrayHasKey( 'template', $properties, '`template` should be included in the schema' );
+        $this->assertArrayHasKey( 'template_lock', $properties, '`template_lock` should be included in the schema' );
     }
 
@@ -231 +254 @@
         $this->assertSame( $post_type_obj->rest_namespace, $data['rest_namespace'] );
         $this->assertSame( $post_type_obj->has_archive, $data['has_archive'] );
+        $this->assertSame( $post_type_obj->template ?? array(), $data['template'] );
+        $this->assertSame( ! empty( $post_type_obj->template_lock ) ? $post_type_obj->template_lock : false, $data['template_lock'] );
 
         $links = test_rest_expand_compact_links( $links );

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -13015 +13015 @@
         "rest_base": "posts",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13045 +13047 @@
         "rest_base": "pages",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13075 +13079 @@
         "rest_base": "media",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13107 +13113 @@
         "rest_base": "menu-items",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13139 +13147 @@
         "rest_base": "blocks",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13169 +13179 @@
         "rest_base": "templates",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13199 +13211 @@
         "rest_base": "template-parts",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13229 +13243 @@
         "rest_base": "global-styles",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13259 +13275 @@
         "rest_base": "navigation",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13289 +13307 @@
         "rest_base": "font-families",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13319 +13339 @@
         "rest_base": "font-families/(?P<font_family_id>[\\d]+)/font-faces",
         "rest_namespace": "wp/v2",
+        "template": [],
+        "template_lock": false,
         "_links": {
             "collection": [
@@ -13353 +13375 @@
     ],
     "rest_base": "posts",
-    "rest_namespace": "wp/v2"
+    "rest_namespace": "wp/v2",
+    "template": [],
+    "template_lock": false
 };