WP_REST_Server::error_to_response( WP_Error $error )

Converts an error to a response object.


Description 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.


Top ↑

Parameters Parameters

$error

(WP_Error) (Required) WP_Error instance.


Top ↑

Return Return

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


Top ↑

Source Source

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

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


Top ↑

Changelog Changelog

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

Top ↑

User Contributed Notes User Contributed Notes

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