WP_REST_Server::respond_to_request( WP_REST_Request $request, string $route, array $handler, WP_Error|null $response ): WP_REST_Response

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$requestWP_REST_Request

The request object.

$routestring

The matched route regex.

$handlerarray

The matched route handler.

$responseWP_Error|null

The current error object if any.

Return value

WP_REST_Response

Performance profile

How much work a call to WP_REST_Server::respond_to_request() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

41–84

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 92.

Plugin surface

3 hooks

Third-party callbacks on 'rest_request_before_callbacks', 'rest_dispatch_request', 'rest_request_after_callbacks' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 18 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Server::respond_to_request() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while WP_REST_Server::respond_to_request() runs, in this order:

1. 1
   apply_filters( rest_request_before_callbacks )filterline 1255 (+18 into the body)

   Filters the response before executing any REST API callbacks.

2. 2
   apply_filters( rest_dispatch_request )filterline 1286 (+49 into the body)

   Filters the REST API dispatch request result.

3. 3
   apply_filters( rest_request_after_callbacks )filterline 1317 (+80 into the body)

   Filters the response immediately after executing any REST API callbacks.

Uses · 7

• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• rest_authorization_required_code()Returns a contextual HTTP error code for authorization failure.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_Error::__construct()Initializes the error.
• WP_REST_Server::error_to_response()Converts an error to a response object.

Used by · 2

• WP_REST_Server::dispatch()Matches the request to a callback and call it.
• WP_REST_Server::serve_batch_request_v1()Serves the batch/v1 request.

Source code

View on Trac ↗View on GitHub ↗

1237	protected function respond_to_request( $request, $route, $handler, $response ) {1238		/**1239		 * Filters the response before executing any REST API callbacks.1240		 *1241		 * Allows plugins to perform additional validation after a1242		 * request is initialized and matched to a registered route,1243		 * but before it is executed.1244		 *1245		 * Note that this filter will not be called for requests that1246		 * fail to authenticate or match to a registered route.1247		 *1248		 * @since 4.7.01249		 *1250		 * @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response Result to send to the client.1251		 *                                                                   Usually a WP_REST_Response or WP_Error.1252		 * @param array                                            $handler  Route handler used for the request.1253		 * @param WP_REST_Request                                  $request  Request used to generate the response.1254		 */1255		$response = apply_filters( 'rest_request_before_callbacks', $response, $handler, $request );1256 1257		// Check permission specified on the route.1258		if ( ! is_wp_error( $response ) && ! empty( $handler['permission_callback'] ) ) {1259			$permission = call_user_func( $handler['permission_callback'], $request );1260 1261			if ( is_wp_error( $permission ) ) {1262				$response = $permission;1263			} elseif ( false === $permission || null === $permission ) {1264				$response = new WP_Error(1265					'rest_forbidden',1266					__( 'Sorry, you are not allowed to do that.' ),1267					array( 'status' => rest_authorization_required_code() )1268				);1269			}1270		}1271 1272		if ( ! is_wp_error( $response ) ) {1273			/**1274			 * Filters the REST API dispatch request result.1275			 *1276			 * Allow plugins to override dispatching the request.1277			 *1278			 * @since 4.4.01279			 * @since 4.5.0 Added `$route` and `$handler` parameters.1280			 *1281			 * @param mixed           $dispatch_result Dispatch result, will be used if not empty.1282			 * @param WP_REST_Request $request         Request used to generate the response.1283			 * @param string          $route           Route matched for the request.1284			 * @param array           $handler         Route handler used for the request.1285			 */1286			$dispatch_result = apply_filters( 'rest_dispatch_request', null, $request, $route, $handler );1287 1288			// Allow plugins to halt the request via this filter.1289			if ( null !== $dispatch_result ) {1290				$response = $dispatch_result;1291			} else {1292				$response = call_user_func( $handler['callback'], $request );1293			}1294		}1295 1296		/**1297		 * Filters the response immediately after executing any REST API1298		 * callbacks.1299		 *1300		 * Allows plugins to perform any needed cleanup, for example,1301		 * to undo changes made during the {@see 'rest_request_before_callbacks'}1302		 * filter.1303		 *1304		 * Note that this filter will not be called for requests that1305		 * fail to authenticate or match to a registered route.1306		 *1307		 * Note that an endpoint's `permission_callback` can still be1308		 * called after this filter - see `rest_send_allow_header()`.1309		 *1310		 * @since 4.7.01311		 *1312		 * @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response Result to send to the client.1313		 *                                                                   Usually a WP_REST_Response or WP_Error.1314		 * @param array                                            $handler  Route handler used for the request.1315		 * @param WP_REST_Request                                  $request  Request used to generate the response.1316		 */

Changelog

Introduced in 5.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/rest-api/class-wp-rest-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.