Themes REST API endpoint: Add stylesheet_uri and template_uri fields to the response #6399

andrewserong · 2024-04-17T02:52:12Z

Based on an idea from @ramonjd and @noisysocks in WordPress/gutenberg#60578, this PR explores adding stylesheet_uri and template_uri fields to the API response for the themes endpoint. The goal being to expose the URI of the directory for a theme (or its parent theme when dealing with child themes) so that theme relative URIs can be constructed by consumers of this endpoint. An example use case is in WordPress/gutenberg#60578

A quick way to test this is to apply the PR and then open up the post editor and run the following from the console:

wp.apiFetch( { path: '/wp/v2/themes/twentytwentyfour' } );

In the API response, you should see stylesheet and template uris in the response:

Trac ticket: https://core.trac.wordpress.org/ticket/61021

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

…to response

github-actions · 2024-04-17T02:52:31Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props andrewserong, timothyblynjacobs, noisysocks, ramonopoly, peterwilsoncc.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions · 2024-04-17T03:20:07Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

andrewserong · 2024-04-17T06:18:57Z

I've updated and added tests. A few questions for anyone reviewing:

These two fields refer to the directory, should that be in the name as well, or is stylesheet_uri and template_uri straightforward enough?
Other fields have raw and rendered versions of the URI (i.e. author_uri and theme_uri are objects with raw and rendered keys). Should we do that for these, too? My assumption is that since these new fields are meant to be used to construct URIs rather than to be displayed, the answer would be no. But for consistency it might be confusing if these are just strings.
Are these values safe to expose in this way? I.e. if you have permission to get all the other data from this endpoint, is this extra data consistent with the current permissions / capabilities?

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

TimothyBJacobs · 2024-04-17T14:07:00Z

It seems unexpected that this is not applying the stylesheet_directory_uri because it isn't using the global get_stylesheet_directory_uri function. We probably need to alter how the response is prepared if it's the current theme or not. See the is_same_theme helper.

andrewserong · 2024-04-17T23:39:29Z

Thanks for the review @TimothyBJacobs!

It seems unexpected that this is not applying the stylesheet_directory_uri because it isn't using the global get_stylesheet_directory_uri function

Good catch! I've updated the logic in b1dd7ff so that it calls the global functions for both the template directory uri and the stylesheet directory uri if the current theme matches the requested theme, so I believe this should hook into those filters now. I'm not very familiar with this part of the code base, though, so do let me know if there's anything off with this approach.

Thanks!

noisysocks · 2024-04-18T01:00:13Z

Gave this for a spin locally by checking the branch out and creating a child theme of TT4 called tt4-child:

% http -a "admin:password" GET http://localhost:8889/wp-json/wp/v2/themes | jq '.[] | { stylesheet, status, template_uri, stylesheet_uri }'
{
  "stylesheet": "tt4-child",
  "status": "active",
  "template_uri": "http://localhost:8889/wp-content/themes/twentytwentyfour",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/tt4-child"
}
{
  "stylesheet": "twentyeleven",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentyeleven",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentyeleven"
}
{
  "stylesheet": "twentyfifteen",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentyfifteen",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentyfifteen"
}
{
  "stylesheet": "twentyfourteen",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentyfourteen",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentyfourteen"
}
{
  "stylesheet": "twentynineteen",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentynineteen",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentynineteen"
}
{
  "stylesheet": "twentyseventeen",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentyseventeen",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentyseventeen"
}
{
  "stylesheet": "twentysixteen",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentysixteen",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentysixteen"
}
{
  "stylesheet": "twentyten",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentyten",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentyten"
}
{
  "stylesheet": "twentythirteen",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentythirteen",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentythirteen"
}
{
  "stylesheet": "twentytwelve",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentytwelve",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentytwelve"
}
{
  "stylesheet": "twentytwenty",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentytwenty",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentytwenty"
}
{
  "stylesheet": "twentytwentyfour",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentytwentyfour",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentytwentyfour"
}
{
  "stylesheet": "twentytwentyone",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentytwentyone",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentytwentyone"
}
{
  "stylesheet": "twentytwentythree",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentytwentythree",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentytwentythree"
}
{
  "stylesheet": "twentytwentytwo",
  "status": "inactive",
  "template_uri": "http://localhost:8889/wp-content/themes/twentytwentytwo",
  "stylesheet_uri": "http://localhost:8889/wp-content/themes/twentytwentytwo"
}

noisysocks

Code LGTM to me too. Nice work 👍

ramonjd · 2024-04-18T01:13:06Z

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

+	 * @ticket 61021
+	 */
+	public function test_theme_template_uri() {
+		$response      = self::perform_active_theme_request();


Would it worth testing inactive themes as well after b1dd7ff?

Oh, thanks for spotting that! I've updated the tests in b444489 to include both active and inactive themes in the response, and loop over the results to check against the global function or the method on the theme object, depending on the status.

Let me know if you think it's better to split into separate tests, though.

ramonjd · 2024-04-18T03:11:30Z

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

+		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'] );


Thanks for updating! LGTM

The only thing I'd do is add a message as the third argument to the assertSames so that failing tests return something meaningful.

Good point 👍

Added in: 23cae05. Happy to tweak the wording if need be.

ramonjd · 2024-04-18T03:18:03Z

Thanks for working on this 🙇🏻 LGTM!

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

…ailures

andrewserong · 2024-04-19T01:42:36Z

Thanks for all the reviews, everyone! I'll be AFK over the next week, so in case there's any further feedback, I won't be able to get to it until the week after. In the meantime, feel free to commit to this branch if anyone would like to make changes, (or commit the changeset if this feels like it's in a good enough place). Cheers!

TimothyBJacobs · 2024-06-02T19:26:14Z

Merged in r58282.

ramonjd · 2024-06-03T00:27:18Z

Should we also sync these changes to Gutenberg?

There's currently no feature that relies on these properties, but maybe it should be synced to compat/6.6 in case that changes between now and 6.9 (when support for 6.6 is dropped in the plugin).

It's likely these properties will be needed to resolve relative asset paths in template/pattern files.

I'd already synced the REST change for a previous experiment so I threw up a PR just in case:

Themes REST API endpoint: Add stylesheet_uri and template_uri fields to the response (WP 6.6) gutenberg#62211

andrewserong · 2024-06-03T00:38:03Z

Good idea @ramonjd — yes, even though there are no features depending on it, I think it'd be good to have parity for the feature in Gutenberg to make it easier to use if need be.

Themes REST API endpoint: Add stylesheet_uri and template_uri fields …

7c516a8

…to response

This was referenced Apr 17, 2024

Background image: add support for absolute theme path URLs WordPress/gutenberg#60578

Closed

Background Image block support follow-up tasks WordPress/gutenberg#54336

Open

Update comment

af9f8b8

andrewserong added 2 commits April 17, 2024 16:07

Call method on the theme object

0c126a5

Add and update tests

784fb46

TimothyBJacobs reviewed Apr 17, 2024

View reviewed changes

src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php Show resolved Hide resolved

Use global functions if the requested theme is the current theme

b1dd7ff

noisysocks approved these changes Apr 18, 2024

View reviewed changes

ramonjd reviewed Apr 18, 2024

View reviewed changes

Update tests to include inactive themes

b444489

ramonjd reviewed Apr 18, 2024

View reviewed changes

peterwilsoncc reviewed Apr 18, 2024

View reviewed changes

src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php Show resolved Hide resolved

Add messages to the assertSame calls to help explain potential test f…

23cae05

…ailures

TimothyBJacobs closed this Jun 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Themes REST API endpoint: Add stylesheet_uri and template_uri fields to the response #6399

Themes REST API endpoint: Add stylesheet_uri and template_uri fields to the response #6399

andrewserong commented Apr 17, 2024 •

edited

Loading

github-actions bot commented Apr 17, 2024 •

edited

Loading

github-actions bot commented Apr 17, 2024

andrewserong commented Apr 17, 2024

TimothyBJacobs commented Apr 17, 2024

andrewserong commented Apr 17, 2024

noisysocks commented Apr 18, 2024 •

edited

Loading

noisysocks left a comment

ramonjd Apr 18, 2024

andrewserong Apr 18, 2024 •

edited

Loading

ramonjd Apr 18, 2024

andrewserong Apr 18, 2024

ramonjd commented Apr 18, 2024

andrewserong commented Apr 19, 2024

TimothyBJacobs commented Jun 2, 2024

ramonjd commented Jun 3, 2024

andrewserong commented Jun 3, 2024

Themes REST API endpoint: Add stylesheet_uri and template_uri fields to the response #6399

Themes REST API endpoint: Add stylesheet_uri and template_uri fields to the response #6399

Conversation

andrewserong commented Apr 17, 2024 • edited Loading

github-actions bot commented Apr 17, 2024 • edited Loading

github-actions bot commented Apr 17, 2024

Test using WordPress Playground

Some things to be aware of

andrewserong commented Apr 17, 2024

TimothyBJacobs commented Apr 17, 2024

andrewserong commented Apr 17, 2024

noisysocks commented Apr 18, 2024 • edited Loading

noisysocks left a comment

Choose a reason for hiding this comment

ramonjd Apr 18, 2024

Choose a reason for hiding this comment

andrewserong Apr 18, 2024 • edited Loading

Choose a reason for hiding this comment

ramonjd Apr 18, 2024

Choose a reason for hiding this comment

andrewserong Apr 18, 2024

Choose a reason for hiding this comment

ramonjd commented Apr 18, 2024

andrewserong commented Apr 19, 2024

TimothyBJacobs commented Jun 2, 2024

ramonjd commented Jun 3, 2024

andrewserong commented Jun 3, 2024

andrewserong commented Apr 17, 2024 •

edited

Loading

github-actions bot commented Apr 17, 2024 •

edited

Loading

noisysocks commented Apr 18, 2024 •

edited

Loading

andrewserong Apr 18, 2024 •

edited

Loading