<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58282] trunk: REST API: Add stylesheet and template URI fields to the Themes API.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58282">58282</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58282","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-02 19:25:03 +0000 (Sun, 02 Jun 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>REST API: Add stylesheet and template URI fields to the Themes API.
Props andrewserong, timothyblynjacobs, noisysocks, ramonopoly, peterwilsoncc, Dharm1025.
Fixes <a href="https://core.trac.wordpress.org/ticket/61021">#61021</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestthemescontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestthemescontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-themes-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestthemescontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php 2024-06-02 15:14:35 UTC (rev 58281)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php 2024-06-02 19:25:03 UTC (rev 58282)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,6 +224,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0 Renamed `$theme` to `$item` to match parent class for PHP 8 named parameter support.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Added `stylesheet_uri` and `template_uri` fields.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Theme $item Theme object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Request object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -331,6 +332,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data['is_block_theme'] = $theme->is_block_theme();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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();
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $data = $this->add_additional_fields_to_object( $data, $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Wrap the data in a response object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -447,11 +464,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'readonly' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'stylesheet_uri' => array(
+ 'description' => __( 'The uri for the theme\'s stylesheet directory.' ),
+ 'type' => 'string',
+ 'format' => 'uri',
+ 'readonly' => true,
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'template' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> '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.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'readonly' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '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,
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'author' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'The theme author.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestthemescontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-themes-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-themes-controller.php 2024-06-02 15:14:35 UTC (rev 58281)
+++ trunk/tests/phpunit/tests/rest-api/rest-themes-controller.php 2024-06-02 19:25:03 UTC (rev 58282)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -162,6 +162,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Test retrieving a collection of themes.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 45016
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 61021
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items() {
</span><span class="cx" style="display: block; padding: 0 10px"> $response = self::perform_active_theme_request();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -182,8 +183,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'screenshot',
</span><span class="cx" style="display: block; padding: 0 10px"> 'status',
</span><span class="cx" style="display: block; padding: 0 10px"> 'stylesheet',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'stylesheet_uri',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'tags',
</span><span class="cx" style="display: block; padding: 0 10px"> 'template',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'template_uri',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'textdomain',
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme_supports',
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme_uri',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -198,6 +201,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Test retrieving a collection of inactive themes.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 50152
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 61021
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_inactive() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$admin_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -221,8 +225,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'screenshot',
</span><span class="cx" style="display: block; padding: 0 10px"> 'status',
</span><span class="cx" style="display: block; padding: 0 10px"> 'stylesheet',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'stylesheet_uri',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'tags',
</span><span class="cx" style="display: block; padding: 0 10px"> 'template',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'template_uri',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'textdomain',
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme_uri',
</span><span class="cx" style="display: block; padding: 0 10px"> 'version',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -347,12 +353,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Verify the theme schema.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 45016
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 61021
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_item_schema() {
</span><span class="cx" style="display: block; padding: 0 10px"> $response = self::perform_active_theme_request( 'OPTIONS' );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $properties = $data['schema']['properties'];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertCount( 16, $properties );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertCount( 18, $properties );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'author', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'raw', $properties['author']['properties'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -377,6 +384,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'screenshot', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'status', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'stylesheet', $properties );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( 'stylesheet_uri', $properties );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'tags', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'raw', $properties['tags']['properties'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -384,6 +392,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'rendered', $properties['tags']['properties'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'template', $properties );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( 'template_uri', $properties );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'textdomain', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'theme_supports', $properties );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -535,6 +544,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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"
+ );
+ }
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 49906
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_theme_tags() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -556,6 +596,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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"
+ );
+ }
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 49906
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_theme_textdomain() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1273,8 +1344,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'screenshot',
</span><span class="cx" style="display: block; padding: 0 10px"> 'status',
</span><span class="cx" style="display: block; padding: 0 10px"> 'stylesheet',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'stylesheet_uri',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'tags',
</span><span class="cx" style="display: block; padding: 0 10px"> 'template',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'template_uri',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'textdomain',
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme_uri',
</span><span class="cx" style="display: block; padding: 0 10px"> 'version',
</span></span></pre>
</div>
</div>
</body>
</html>