mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-03-23 05:20:01 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

REST API: Add additional default template data fields for the active theme.
Some checks are pending
Cleanup Pull Requests / Clean up pull requests (push) Waiting to run
Details
Coding Standards / PHP coding standards (push) Waiting to run
Details
Coding Standards / JavaScript coding standards (push) Waiting to run
Details
Coding Standards / Slack Notifications (push) Blocked by required conditions
Details
Coding Standards / Failed workflow tasks (push) Blocked by required conditions
Details
End-to-end Tests / Test with SCRIPT_DEBUG disabled (push) Waiting to run
Details
End-to-end Tests / Test with SCRIPT_DEBUG enabled (push) Waiting to run
Details
End-to-end Tests / Slack Notifications (push) Blocked by required conditions
Details
End-to-end Tests / Failed workflow tasks (push) Blocked by required conditions
Details
JavaScript Tests / QUnit Tests (push) Waiting to run
Details
JavaScript Tests / Slack Notifications (push) Blocked by required conditions
Details
JavaScript Tests / Failed workflow tasks (push) Blocked by required conditions
Details
Performance Tests / Determine Matrix (push) Waiting to run
Details
Performance Tests / ${{ matrix.multisite && 'Multisite' || 'Single Site' }} ${{ matrix.memcached && 'Memcached' || 'Default' }} (push) Blocked by required conditions
Details
Performance Tests / Compare (push) Blocked by required conditions
Details
Performance Tests / Slack Notifications (push) Blocked by required conditions
Details
Performance Tests / Failed workflow tasks (push) Blocked by required conditions
Details
PHP Compatibility / Check PHP compatibility (push) Waiting to run
Details
PHP Compatibility / Slack Notifications (push) Blocked by required conditions
Details
PHP Compatibility / Failed workflow tasks (push) Blocked by required conditions
Details
PHPUnit Tests / PHP 7.2 (push) Waiting to run
Details
PHPUnit Tests / PHP 7.3 (push) Waiting to run
Details
PHPUnit Tests / PHP 7.4 (push) Waiting to run
Details
PHPUnit Tests / PHP 8.0 (push) Waiting to run
Details
PHPUnit Tests / PHP 8.1 (push) Waiting to run
Details
PHPUnit Tests / PHP 8.2 (push) Waiting to run
Details
PHPUnit Tests / PHP 8.3 (push) Waiting to run
Details
PHPUnit Tests / PHP 8.4 (push) Waiting to run
Details
PHPUnit Tests / html-api-html5lib-tests (push) Waiting to run
Details
PHPUnit Tests / Slack Notifications (push) Blocked by required conditions
Details
PHPUnit Tests / Failed workflow tasks (push) Blocked by required conditions
Details
Test Build Processes / Core running from build (push) Waiting to run
Details
Test Build Processes / Core running from src (push) Waiting to run
Details
Test Build Processes / Gutenberg running from build (push) Waiting to run
Details
Test Build Processes / Gutenberg running from src (push) Waiting to run
Details
Test Build Processes / Slack Notifications (push) Blocked by required conditions
Details
Test Build Processes / Failed workflow tasks (push) Blocked by required conditions
Details
Upgrade Develop Version Tests / Build (push) Waiting to run
Details
Upgrade Develop Version Tests / Upgrade from 4.9 (push) Blocked by required conditions
Details
Upgrade Develop Version Tests / Upgrade from 6.5 (push) Blocked by required conditions
Details
Upgrade Develop Version Tests / Upgrade from 6.6 (push) Blocked by required conditions
Details
Upgrade Develop Version Tests / Upgrade from 6.7 (push) Blocked by required conditions
Details
Upgrade Develop Version Tests / Slack Notifications (push) Blocked by required conditions
Details
Upgrade Develop Version Tests / Failed workflow tasks (push) Blocked by required conditions
Details

Browse Source 
The active theme(s) now return two additional properties, `default_template_types` and `default_template_part_areas`, in the REST response.

Props mamaduka, joemcgill, timothyblynjacobs, audrasjb, gigitux, peterwilsoncc, youknowriad, jorbin.
Fixes #62574.

git-svn-id: https://develop.svn.wordpress.org/trunk@59965 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
George Mamadashvili 2025-03-11 06:13:47 +00:00
parent 07e3b258b5
commit 5564c705b1
2 changed files with 109 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php
View File

@ -348,6 +348,19 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
}
}
if ( rest_is_field_included( 'default_template_types', $fields ) && $this->is_same_theme( $theme, $current_theme ) ) {
$default_template_types = array();
foreach ( get_default_block_template_types() as $slug => $template_type ) {
$template_type['slug'] = (string) $slug;
$default_template_types[] = $template_type;
}
$data['default_template_types'] = $default_template_types;
}
if ( rest_is_field_included( 'default_template_part_areas', $fields ) && $this->is_same_theme( $theme, $current_theme ) ) {
$data['default_template_part_areas'] = get_allowed_block_template_part_areas();
}
$data = $this->add_additional_fields_to_object( $data, $request );
// Wrap the data in a response object.
@ -459,29 +472,29 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
'title' => 'theme',
'type' => 'object',
'properties' => array(
'stylesheet' => array(
'stylesheet' => array(
'description' => __( 'The theme\'s stylesheet. This uniquely identifies the theme.' ),
'type' => 'string',
'readonly' => true,
),
'stylesheet_uri' => array(
'stylesheet_uri' => array(
'description' => __( 'The uri for the theme\'s stylesheet directory.' ),
'type' => 'string',
'format' => 'uri',
'readonly' => true,
),
'template' => array(
'template' => array(
'description' => __( 'The theme\'s template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme\'s stylesheet.' ),
'type' => 'string',
'readonly' => true,
),
'template_uri' => array(
'template_uri' => array(
'description' => __( 'The uri for the theme\'s template directory. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme\'s stylesheet directory.' ),
'type' => 'string',
'format' => 'uri',
'readonly' => true,
),
'author' => array(
'author' => array(
'description' => __( 'The theme author.' ),
'type' => 'object',
'readonly' => true,
@ -496,7 +509,7 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
),
),
),
'author_uri' => array(
'author_uri' => array(
'description' => __( 'The website of the theme author.' ),
'type' => 'object',
'readonly' => true,
@ -513,7 +526,7 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
),
),
),
'description' => array(
'description' => array(
'description' => __( 'A description of the theme.' ),
'type' => 'object',
'readonly' => true,
@ -528,12 +541,12 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
),
),
),
'is_block_theme' => array(
'is_block_theme' => array(
'description' => __( 'Whether the theme is a block-based theme.' ),
'type' => 'boolean',
'readonly' => true,
),
'name' => array(
'name' => array(
'description' => __( 'The name of the theme.' ),
'type' => 'object',
'readonly' => true,
@ -548,23 +561,23 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
),
),
),
'requires_php' => array(
'requires_php' => array(
'description' => __( 'The minimum PHP version required for the theme to work.' ),
'type' => 'string',
'readonly' => true,
),
'requires_wp' => array(
'requires_wp' => array(
'description' => __( 'The minimum WordPress version required for the theme to work.' ),
'type' => 'string',
'readonly' => true,
),
'screenshot' => array(
'screenshot' => array(
'description' => __( 'The theme\'s screenshot URL.' ),
'type' => 'string',
'format' => 'uri',
'readonly' => true,
),
'tags' => array(
'tags' => array(
'description' => __( 'Tags indicating styles and features of the theme.' ),
'type' => 'object',
'readonly' => true,
@ -582,18 +595,18 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
),
),
),
'textdomain' => array(
'textdomain' => array(
'description' => __( 'The theme\'s text domain.' ),
'type' => 'string',
'readonly' => true,
),
'theme_supports' => array(
'theme_supports' => array(
'description' => __( 'Features supported by this theme.' ),
'type' => 'object',
'readonly' => true,
'properties' => array(),
),
'theme_uri' => array(
'theme_uri' => array(
'description' => __( 'The URI of the theme\'s webpage.' ),
'type' => 'object',
'readonly' => true,
@ -610,16 +623,60 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
),
),
),
'version' => array(
'version' => array(
'description' => __( 'The theme\'s current version.' ),
'type' => 'string',
'readonly' => true,
),
'status' => array(
'status' => array(
'description' => __( 'A named status for the theme.' ),
'type' => 'string',
'enum' => array( 'inactive', 'active' ),
),
'default_template_types' => array(
'description' => __( 'A list of default template types.' ),
'type' => 'array',
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'slug' => array(
'type' => 'string',
),
'title' => array(
'type' => 'string',
),
'description' => array(
'type' => 'string',
),
),
),
),
'default_template_part_areas' => array(
'description' => __( 'A list of allowed area values for template parts.' ),
'type' => 'array',
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'area' => array(
'type' => 'string',
),
'label' => array(
'type' => 'string',
),
'description' => array(
'type' => 'string',
),
'icon' => array(
'type' => 'string',
),
'area_tag' => array(
'type' => 'string',
),
),
),
),
),
);

35
tests/phpunit/tests/rest-api/rest-themes-controller.php
View File

@ -163,6 +163,7 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase {
*
* @ticket 45016
* @ticket 61021
* @ticket 62574.
*/
public function test_get_items() {
$response = self::perform_active_theme_request();
@ -175,6 +176,8 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase {
'_links',
'author',
'author_uri',
'default_template_part_areas',
'default_template_types',
'description',
'is_block_theme',
'name',
@ -354,12 +357,13 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase {
*
* @ticket 45016
* @ticket 61021
* @ticket 62574
*/
public function test_get_item_schema() {
$response = self::perform_active_theme_request( 'OPTIONS' );
$data = $response->get_data();
$properties = $data['schema']['properties'];
$this->assertCount( 18, $properties );
$this->assertCount( 20, $properties );
$this->assertArrayHasKey( 'author', $properties );
$this->assertArrayHasKey( 'raw', $properties['author']['properties'] );
@ -373,6 +377,9 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase {
$this->assertArrayHasKey( 'raw', $properties['description']['properties'] );
$this->assertArrayHasKey( 'rendered', $properties['description']['properties'] );
$this->assertArrayHasKey( 'default_template_part_areas', $properties );
$this->assertArrayHasKey( 'default_template_types', $properties );
$this->assertArrayHasKey( 'is_block_theme', $properties );
$this->assertArrayHasKey( 'name', $properties );
@ -472,6 +479,32 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase {
);
}
/**
* @ticket 62574
*/
public function test_theme_default_template_part_areas() {
$response = self::perform_active_theme_request();
$result = $response->get_data();
$this->assertArrayHasKey( 'default_template_part_areas', $result[0] );
$this->assertSame( get_allowed_block_template_part_areas(), $result[0]['default_template_part_areas'] );
}
/**
* @ticket 62574
*/
public function test_theme_default_template_types() {
$response = self::perform_active_theme_request();
$result = $response->get_data();
$expected = array();
foreach ( get_default_block_template_types() as $slug => $template_type ) {
$template_type['slug'] = (string) $slug;
$expected[] = $template_type;
}
$this->assertArrayHasKey( 'default_template_types', $result[0] );
$this->assertSame( $expected, $result[0]['default_template_types'] );
}
/**
* @ticket 49906
*/