Changeset 59073 for trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

Timestamp:

09/20/2024 02:05:50 AM (18 months ago)

Author:

noisysocks

Message:

Editor: Add plugin template registration API and improve theme overrides for plugin-registered templates

This commit introduces a new API to allow plugins to easily register block
templates with wp_register_block_template() and the
WP_Block_Templates_Registry class, addressing the complexity of hooking into
multiple filters. It also ensures plugin-registered templates overridden by
themes fall back to the plugin-provided title and description when the theme
doesn't define them.

See ​https://github.com/WordPress/gutenberg/pull/61577.
See ​https://github.com/WordPress/gutenberg/pull/64610.

Fixes #61804.
Props aljullu, peterwilsoncc, antonvlasenko, azaozz, youknowriad, noisysocks.

File:

• trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php (modified) (3 diffs)

trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

@@ -530 +530 @@
 
     /**
+     * Tests that get_item() returns plugin-registered templates.
+     *
+     * @ticket 61804
+     *
+     * @covers WP_REST_Templates_Controller::get_item
+     */
+    public function test_get_item_from_registry() {
+        wp_set_current_user( self::$admin_id );
+
+        $template_name = 'test-plugin//test-template';
+        $args          = array(
+            'content'     => 'Template content',
+            'title'       => 'Test Template',
+            'description' => 'Description of test template',
+            'post_types'  => array( 'post', 'page' ),
+        );
+
+        wp_register_block_template( $template_name, $args );
+
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/templates/test-plugin//test-template' );
+        $response = rest_get_server()->dispatch( $request );
+
+        $this->assertNotWPError( $response, "Fetching a registered template shouldn't cause an error." );
+
+        $data = $response->get_data();
+
+        $this->assertSame( 'default//test-template', $data['id'], 'Template ID mismatch.' );
+        $this->assertSame( 'default', $data['theme'], 'Template theme mismatch.' );
+        $this->assertSame( 'Template content', $data['content']['raw'], 'Template content mismatch.' );
+        $this->assertSame( 'test-template', $data['slug'], 'Template slug mismatch.' );
+        $this->assertSame( 'plugin', $data['source'], "Template source should be 'plugin'." );
+        $this->assertSame( 'plugin', $data['origin'], "Template origin should be 'plugin'." );
+        $this->assertSame( 'test-plugin', $data['author_text'], 'Template author text mismatch.' );
+        $this->assertSame( 'Description of test template', $data['description'], 'Template description mismatch.' );
+        $this->assertSame( 'Test Template', $data['title']['rendered'], 'Template title mismatch.' );
+        $this->assertSame( 'test-plugin', $data['plugin'], 'Plugin name mismatch.' );
+
+        wp_unregister_block_template( $template_name );
+
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/templates/test-plugin//test-template' );
+        $response = rest_get_server()->dispatch( $request );
+
+        $this->assertNotWPError( $response, "Fetching an unregistered template shouldn't cause an error." );
+        $this->assertSame( 404, $response->get_status(), 'Fetching an unregistered template should return 404.' );
+    }
+
+    /**
      * @ticket 54507
      * @dataProvider data_sanitize_template_id
@@ -864 +911 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertCount( 17, $properties );
+        $this->assertCount( 18, $properties );
         $this->assertArrayHasKey( 'id', $properties );
         $this->assertArrayHasKey( 'description', $properties );
@@ -883 +930 @@
         $this->assertArrayHasKey( 'author_text', $properties );
         $this->assertArrayHasKey( 'original_source', $properties );
+        $this->assertArrayHasKey( 'plugin', $properties );
     }