Changeset 55951

Timestamp:

06/20/2023 10:15:57 PM (3 years ago)

Author:

audrasjb

Message:

REST API: Indicate when a theme supports the Site editor in the Themes REST API response.

This changeset adds a is_block_theme property to each theme in the wp/v2/themes API response, which uses WP_Theme::is_block_theme to determinate whether
the theme is block theme or not.

Props grantmkin, ironprogrammer, zunaid321, azaozz, spacedmonkey, audrasjb, costdev.
Fixes #58123.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-themes-controller.php (modified) (8 diffs)

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

@@ -327 +327 @@
                 }
 
+                if ( rest_is_field_included( 'is_block_theme', $fields ) ) {
+                        $data['is_block_theme'] = $theme->is_block_theme();
+                }
+
                 $data = $this->add_additional_fields_to_object( $data, $request );
 
@@ -495 +499 @@
                                         ),
                                 ),
+                                'is_block_theme' => array(
+                                        'description' => __( 'Whether the theme is a block-based theme.' ),
+                                        'type'        => 'boolean',
+                                        'readonly'    => true,
+                                ),
                                 'name'           => array(
                                         'description' => __( 'The name of the theme.' ),

trunk/tests/phpunit/tests/rest-api/rest-themes-controller.php

@@ -173 +173 @@
                         'author_uri',
                         'description',
+                        'is_block_theme',
                         'name',
                         'requires_php',
@@ -186 +187 @@
                         'version',
                 );
+                $this->assertIsArray( $data );
+                $this->assertNotEmpty( $data );
                 $this->assertSameSets( $fields, array_keys( $data[0] ) );
         }
@@ -209 +212 @@
                         'author_uri',
                         'description',
+                        'is_block_theme',
                         'name',
                         'requires_php',
@@ -221 +225 @@
                         'version',
                 );
+                $this->assertIsArray( $data );
+                $this->assertNotEmpty( $data );
                 $this->assertSameSets( $fields, array_keys( $data[0] ) );
 
@@ -344 +350 @@
                 $data       = $response->get_data();
                 $properties = $data['schema']['properties'];
-                $this->assertCount( 15, $properties );
+                $this->assertCount( 16, $properties );
 
                 $this->assertArrayHasKey( 'author', $properties );
@@ -357 +363 @@
                 $this->assertArrayHasKey( 'raw', $properties['description']['properties'] );
                 $this->assertArrayHasKey( 'rendered', $properties['description']['properties'] );
+
+                $this->assertArrayHasKey( 'is_block_theme', $properties );
 
                 $this->assertArrayHasKey( 'name', $properties );
@@ -473 +481 @@
 
         /**
+         * @ticket 58123
+         * @covers WP_REST_Themes_Controller::prepare_item_for_response
+         */
+        public function test_theme_is_block_theme() {
+                // Test classic theme, activated in test setup.
+                $response = self::perform_active_theme_request();
+                $result   = $response->get_data();
+
+                $this->assertArrayHasKey( 'is_block_theme', $result[0] );
+                $this->assertFalse( $result[0]['is_block_theme'] );
+
+                // Test block theme.
+                switch_theme( 'block-theme' );
+                $response = self::perform_active_theme_request();
+                $result   = $response->get_data();
+
+                $this->assertArrayHasKey( 'is_block_theme', $result[0] );
+                $this->assertTrue( $result[0]['is_block_theme'] );
+        }
+
+        /**
          * @ticket 49906
          */
@@ -1235 +1264 @@
                         'author_uri',
                         'description',
+                        'is_block_theme',
                         'name',
                         'requires_php',