WP_REST_Server::error_to_response() – Method

WP_REST_Server::error_to_response( WP_Error $error ): WP_REST_Response

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

Changelog

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

User Contributed Notes

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