Implement functions to check whether the current request is a REST request and whether a REST endpoint request is currently being handled #5658

felixarntz · 2023-11-10T20:36:57Z

This PR introduces two new functions:

wp_is_rest_request() checks whether the current request is an actual "standalone" REST request. This function does not provide any filter, similar to how e.g. it is not possible to filter whether a request is a WP Admin request. There's probably no good reason to change that now.
wp_is_rest_endpoint() checks whether a REST request to an endpoint is currently being handled. This is the case for any standalone REST request, as well as any internal REST requests made via another regular WordPress request (e.g. via rest_preload_api_request()). This function provides a filter as it can allow custom implementations for handling a REST request to remain compatible with this check.

The rationale for two separate functions is that those two things are distinct aspects. Most current core usage checking the REST_REQUEST constant in core is actually about whether a REST endpoint is being handled. Only a few general infrastructure checks depend on whether the current request is actually a "standalone" REST request.

All relevant usages of REST_REQUEST have been updated, or a comment has been added why they should not be updated.

To do: Add unit test coverage (once there's alignment on the approach).

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

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.

… whether a REST endpoint request is currently being handled.

sybrew · 2023-11-14T13:43:46Z

src/wp-includes/functions.php

+ *
+ * @return bool True if it's a WordPress REST API request, false otherwise.
+ */
+function wp_is_rest_request(): bool {


Setting a return type slows this function down by about 20%

@sybrew I'm not sure where you get this from. In any case, I am sure the time this function takes is irrelevant in the grand scheme of things, since it's just a constant check.

@felixarntz every time a value is returned, its type is checked. This requires more processing time. Simply allowing to pass the value unchecked executes no additional code, so that's faster.

I'm trying to prevent this from becoming the norm. PHP isn't typed and nothing has been done to optimize type hinting thus far for userland. It's only a waste of resources.

@sybrew That's fair. It probably requires a larger discussion, not in a specific ticket like this. I'm not sure what I think about it yet, but it looks like this would be the first return type in core anyway, so I'll just leave it out. Done in 32a27c6

(Crosstalk) There's also no need to crash a user's site because a wrong type is used during development. Just make sure this doesn't happen; it's easily achievable. We have PHPDoc, static code checks, and unit testing to help us with this. We write the code, so we can ascertain the return type without type hinting.

petitphp · 2024-01-15T18:23:37Z

src/wp-includes/rest-api.php

+ *
+ * @return bool True if a REST endpoint request is currently being handled, false otherwise.
+ */
+function wp_is_rest_endpoint(): bool {


Since we have access to the full REST request object, we could add a $endpoint parameter to this function to allow developers to check which endpoint if currently dispatched, like what is possible with is_post_type_archive.

if ( wp_is_rest_endpoint( 'wp/v2/post' ) ) {...}

This could be done, but it's not in scope of this ticket/PR. Checking for a specific endpoint is a separate use-case, which I think should be explored in a separate ticket. It could be implemented later.

felixarntz · 2024-01-18T16:50:15Z

@TimothyBJacobs Is there any chance you can get to reviewing this? :)

src/wp-includes/rest-api.php

TimothyBJacobs · 2024-01-18T16:57:39Z

I know we document expect usage timing in the function docs, but it feels so similar to things like wp_doing_ajax or wp_doing_cron that I think developers will expect they can use it early.

Maybe wp_is_serving_rest_request would make that a bit clearer that it won't return true until the REST API Server is actually handling it?

github-actions · 2024-01-18T17:08:47Z

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.

felixarntz · 2024-01-18T17:28:06Z

Thanks @TimothyBJacobs, I've updated the PR based on your feedback.

TimothyBJacobs

looks great to me!

sybrew · 2024-01-19T00:43:21Z

src/wp-includes/rest-api/class-wp-rest-server.php

@@ -1068,7 +1068,7 @@ public function dispatch( $request ) {
 	 * @return bool Whether the REST server is currently handling a request.
 	 */
 	public function is_dispatching() {
-		return empty( $this->dispatching_requests );
+		return ! empty( $this->dispatching_requests );


Since the property is registered, return (bool) $this->dispatching_requests; would also work (and is about 15% faster).

Updated in e09b4a0

felixarntz · 2024-01-19T17:39:01Z

Committed in https://core.trac.wordpress.org/changeset/57312

Implement functions to check whether a REST request is being made and…

63d9e57

… whether a REST endpoint request is currently being handled.

felixarntz requested a review from TimothyBJacobs November 10, 2023 20:36

felixarntz added 2 commits November 10, 2023 12:48

Get rid of unnecessarily strict _doing_it_wrong().

e251d98

Avoid editing Gutenberg block file managed via dependency.

44a8960

sybrew reviewed Nov 14, 2023

View reviewed changes

petitphp reviewed Jan 15, 2024

View reviewed changes

felixarntz added 2 commits January 18, 2024 08:48

Merge branch 'trunk' into enhance/42061-rest-check-functions

2a2716b

Fix for wrong merge resolution.

a009157

TimothyBJacobs reviewed Jan 18, 2024

View reviewed changes

src/wp-includes/rest-api.php Outdated Show resolved Hide resolved

felixarntz added 2 commits January 18, 2024 09:23

Remove method_exists() check.

59c8fb1

Rename wp_is_rest_request() to wp_is_serving_rest_request().

67c85b7

TimothyBJacobs approved these changes Jan 18, 2024

View reviewed changes

Remove return types.

32a27c6

felixarntz mentioned this pull request Jan 18, 2024

Support checking for a REST API request before the query is parsed #916

Closed

Add tests and fix critical logic bug.

97ce714

sybrew reviewed Jan 19, 2024

View reviewed changes

felixarntz added 2 commits January 19, 2024 09:23

Merge branch 'trunk' into enhance/42061-rest-check-functions

d63898c

Use bool cast instead of ! empty check.

e09b4a0

felixarntz closed this Jan 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement functions to check whether the current request is a REST request and whether a REST endpoint request is currently being handled #5658

Implement functions to check whether the current request is a REST request and whether a REST endpoint request is currently being handled #5658

felixarntz commented Nov 10, 2023 •

edited

Loading

sybrew Nov 14, 2023

felixarntz Jan 18, 2024

sybrew Jan 18, 2024

felixarntz Jan 18, 2024

sybrew Jan 18, 2024 •

edited

Loading

petitphp Jan 15, 2024 •

edited

Loading

felixarntz Jan 18, 2024

felixarntz commented Jan 18, 2024

TimothyBJacobs commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

felixarntz commented Jan 18, 2024

TimothyBJacobs left a comment

sybrew Jan 19, 2024

felixarntz Jan 19, 2024

felixarntz commented Jan 19, 2024

Implement functions to check whether the current request is a REST request and whether a REST endpoint request is currently being handled #5658

Implement functions to check whether the current request is a REST request and whether a REST endpoint request is currently being handled #5658

Conversation

felixarntz commented Nov 10, 2023 • edited Loading

sybrew Nov 14, 2023

Choose a reason for hiding this comment

felixarntz Jan 18, 2024

Choose a reason for hiding this comment

sybrew Jan 18, 2024

Choose a reason for hiding this comment

felixarntz Jan 18, 2024

Choose a reason for hiding this comment

sybrew Jan 18, 2024 • edited Loading

Choose a reason for hiding this comment

petitphp Jan 15, 2024 • edited Loading

Choose a reason for hiding this comment

felixarntz Jan 18, 2024

Choose a reason for hiding this comment

felixarntz commented Jan 18, 2024

TimothyBJacobs commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

Test using WordPress Playground

Some things to be aware of

felixarntz commented Jan 18, 2024

TimothyBJacobs left a comment

Choose a reason for hiding this comment

sybrew Jan 19, 2024

Choose a reason for hiding this comment

felixarntz Jan 19, 2024

Choose a reason for hiding this comment

felixarntz commented Jan 19, 2024

felixarntz commented Nov 10, 2023 •

edited

Loading

sybrew Jan 18, 2024 •

edited

Loading

petitphp Jan 15, 2024 •

edited

Loading