WP_REST_Server::error_to_response( WP_Error $error )

Converts an error to a response object.

Description

This iterates over all error codes and messages to change it into a flat array. This enables simpler client behaviour, as it is represented as a list in JSON rather than an object/map.

Parameters

$error

(WP_Error) (Required) WP_Error instance.

Return

(WP_REST_Response) List of associative arrays with code and message keys.

Source

File: wp-includes/rest-api/class-wp-rest-server.php 

protected function error_to_response( $error ) {
		return rest_convert_error_to_response( $error );
	}

Used By

Used By Description
wp-includes/rest-api/class-wp-rest-server.php: WP_REST_Server::serve_batch_request_v1()

Serves the batch/v1 request.
wp-includes/rest-api/class-wp-rest-server.php: WP_REST_Server::respond_to_request()

Dispatches the request to the callback handler.
wp-includes/rest-api/class-wp-rest-server.php: WP_REST_Server::dispatch()

Matches the request to a callback and call it.
wp-includes/rest-api/class-wp-rest-server.php: WP_REST_Server::serve_request()

Handles serving a REST API request.

Changelog

Version Description
5.7.0 Converted to a wrapper of rest_convert_error_to_response().
4.4.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_server/error_to_response