From 620fd389cbd3aac18ebfd4eb30c68477640530ab Mon Sep 17 00:00:00 2001 From: Timothy Jacobs Date: Sun, 2 Jun 2024 19:25:03 +0000 Subject: [PATCH] REST API: Add stylesheet and template URI fields to the Themes API. Props andrewserong, timothyblynjacobs, noisysocks, ramonopoly, peterwilsoncc, Dharm1025. Fixes #61021. git-svn-id: https://develop.svn.wordpress.org/trunk@58282 602fd350-edb4-49c9-b593-d223f7449a82 --- .../class-wp-rest-themes-controller.php | 29 +++++++ .../tests/rest-api/rest-themes-controller.php | 75 ++++++++++++++++++- 2 files changed, 103 insertions(+), 1 deletion(-) diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php index 064fc2dd39..0f4da6773a 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php @@ -224,6 +224,7 @@ class WP_REST_Themes_Controller extends WP_REST_Controller { * * @since 5.0.0 * @since 5.9.0 Renamed `$theme` to `$item` to match parent class for PHP 8 named parameter support. + * @since 6.6.0 Added `stylesheet_uri` and `template_uri` fields. * * @param WP_Theme $item Theme object. * @param WP_REST_Request $request Request object. @@ -331,6 +332,22 @@ class WP_REST_Themes_Controller extends WP_REST_Controller { $data['is_block_theme'] = $theme->is_block_theme(); } + if ( rest_is_field_included( 'stylesheet_uri', $fields ) ) { + if ( $this->is_same_theme( $theme, $current_theme ) ) { + $data['stylesheet_uri'] = get_stylesheet_directory_uri(); + } else { + $data['stylesheet_uri'] = $theme->get_stylesheet_directory_uri(); + } + } + + if ( rest_is_field_included( 'template_uri', $fields ) ) { + if ( $this->is_same_theme( $theme, $current_theme ) ) { + $data['template_uri'] = get_template_directory_uri(); + } else { + $data['template_uri'] = $theme->get_template_directory_uri(); + } + } + $data = $this->add_additional_fields_to_object( $data, $request ); // Wrap the data in a response object. @@ -447,11 +464,23 @@ class WP_REST_Themes_Controller extends WP_REST_Controller { 'type' => 'string', 'readonly' => true, ), + 'stylesheet_uri' => array( + 'description' => __( 'The uri for the theme\'s stylesheet directory.' ), + 'type' => 'string', + 'format' => 'uri', + 'readonly' => true, + ), '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( + '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( 'description' => __( 'The theme author.' ), 'type' => 'object', diff --git a/tests/phpunit/tests/rest-api/rest-themes-controller.php b/tests/phpunit/tests/rest-api/rest-themes-controller.php index decf4be322..dfa243d577 100644 --- a/tests/phpunit/tests/rest-api/rest-themes-controller.php +++ b/tests/phpunit/tests/rest-api/rest-themes-controller.php @@ -162,6 +162,7 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { * Test retrieving a collection of themes. * * @ticket 45016 + * @ticket 61021 */ public function test_get_items() { $response = self::perform_active_theme_request(); @@ -182,8 +183,10 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { 'screenshot', 'status', 'stylesheet', + 'stylesheet_uri', 'tags', 'template', + 'template_uri', 'textdomain', 'theme_supports', 'theme_uri', @@ -198,6 +201,7 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { * Test retrieving a collection of inactive themes. * * @ticket 50152 + * @ticket 61021 */ public function test_get_items_inactive() { wp_set_current_user( self::$admin_id ); @@ -221,8 +225,10 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { 'screenshot', 'status', 'stylesheet', + 'stylesheet_uri', 'tags', 'template', + 'template_uri', 'textdomain', 'theme_uri', 'version', @@ -347,12 +353,13 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { * Verify the theme schema. * * @ticket 45016 + * @ticket 61021 */ public function test_get_item_schema() { $response = self::perform_active_theme_request( 'OPTIONS' ); $data = $response->get_data(); $properties = $data['schema']['properties']; - $this->assertCount( 16, $properties ); + $this->assertCount( 18, $properties ); $this->assertArrayHasKey( 'author', $properties ); $this->assertArrayHasKey( 'raw', $properties['author']['properties'] ); @@ -377,6 +384,7 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { $this->assertArrayHasKey( 'screenshot', $properties ); $this->assertArrayHasKey( 'status', $properties ); $this->assertArrayHasKey( 'stylesheet', $properties ); + $this->assertArrayHasKey( 'stylesheet_uri', $properties ); $this->assertArrayHasKey( 'tags', $properties ); $this->assertArrayHasKey( 'raw', $properties['tags']['properties'] ); @@ -384,6 +392,7 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { $this->assertArrayHasKey( 'rendered', $properties['tags']['properties'] ); $this->assertArrayHasKey( 'template', $properties ); + $this->assertArrayHasKey( 'template_uri', $properties ); $this->assertArrayHasKey( 'textdomain', $properties ); $this->assertArrayHasKey( 'theme_supports', $properties ); @@ -534,6 +543,37 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { $this->assertSame( 'rest-api', $result[0]['stylesheet'] ); } + /** + * @ticket 61021 + */ + public function test_theme_stylesheet_uri() { + wp_set_current_user( self::$admin_id ); + $request = new WP_REST_Request( 'GET', self::$themes_route ); + $request->set_param( 'status', array( 'active', 'inactive' ) ); + + $response = rest_get_server()->dispatch( $request ); + $result = $response->get_data(); + $current_theme = wp_get_theme(); + + foreach ( $result as $theme_result ) { + $this->assertArrayHasKey( 'stylesheet_uri', $theme_result ); + if ( 'active' === $theme_result['status'] ) { + $this->assertSame( + get_stylesheet_directory_uri(), + $theme_result['stylesheet_uri'], + 'stylesheet_uri for an active theme should be the same as the global get_stylesheet_directory_uri()' + ); + } else { + $theme = wp_get_theme( $theme_result['stylesheet'] ); + $this->assertSame( + $theme->get_stylesheet_directory_uri(), + $theme_result['stylesheet_uri'], + "stylesheet_uri for an inactive theme should be the same as the theme's get_stylesheet_directory_uri() method" + ); + } + } + } + /** * @ticket 49906 */ @@ -555,6 +595,37 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { $this->assertSame( 'default', $result[0]['template'] ); } + /** + * @ticket 61021 + */ + public function test_theme_template_uri() { + wp_set_current_user( self::$admin_id ); + $request = new WP_REST_Request( 'GET', self::$themes_route ); + $request->set_param( 'status', array( 'active', 'inactive' ) ); + + $response = rest_get_server()->dispatch( $request ); + $result = $response->get_data(); + $current_theme = wp_get_theme(); + + foreach ( $result as $theme_result ) { + $this->assertArrayHasKey( 'template_uri', $theme_result ); + if ( 'active' === $theme_result['status'] ) { + $this->assertSame( + get_template_directory_uri(), + $theme_result['template_uri'], + 'template_uri for an active theme should be the same as the global get_template_directory_uri()' + ); + } else { + $theme = wp_get_theme( $theme_result['stylesheet'] ); + $this->assertSame( + $theme->get_template_directory_uri(), + $theme_result['template_uri'], + "template_uri for an inactive theme should be the same as the theme's get_template_directory_uri() method" + ); + } + } + } + /** * @ticket 49906 */ @@ -1273,8 +1344,10 @@ class WP_Test_REST_Themes_Controller extends WP_Test_REST_Controller_Testcase { 'screenshot', 'status', 'stylesheet', + 'stylesheet_uri', 'tags', 'template', + 'template_uri', 'textdomain', 'theme_uri', 'version',