WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Server::error_to_response()

WP_REST_Server::error_to_response( WP_Error $error ): WP_REST_Response

In this article

Back to top

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 behavior, as it is represented as a list in JSON rather than an object/map.

Parameters

$errorWP_Errorrequired
WP_Error instance.

Return

WP_REST_Response List of associative arrays with code and message keys.

Source

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

View all references View on Trac View on GitHub

UsesDescription
rest_convert_error_to_response()wp-includes/rest-api.php

Converts an error to a response object.

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

Serves the batch/v1 request.

WP_REST_Server::respond_to_request()wp-includes/rest-api/class-wp-rest-server.php

Dispatches the request to the callback handler.

WP_REST_Server::dispatch()wp-includes/rest-api/class-wp-rest-server.php

Matches the request to a callback and call it.

WP_REST_Server::serve_request()wp-includes/rest-api/class-wp-rest-server.php

Handles serving a REST API request.

Changelog

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

User Contributed Notes

You must log in before being able to contribute a note or feedback.