WP_REST_Server::json_error() – Method

WP_REST_Server::json_error( string $code, string $message, int $status = null ): string

Retrieves an appropriate error representation in JSON.

Description

Note: This should only be used in WP_REST_Server::serve_request(), as it cannot handle WP_Error internally. All callbacks and other internal methods should instead return a WP_Error with the data set to an array that includes a ‘status’ key, with the value being the HTTP status to send.

Parameters

$codestringrequired: WP_Error-style code.
$messagestringrequired: Human-readable message.
$statusintoptional: HTTP status code to send.
Default:null

Return

string JSON representation of the error

Source

protected function json_error( $code, $message, $status = null ) {	if ( $status ) {	$this->set_status( $status );	}	$error = compact( 'code', 'message' );	return wp_json_encode( $error ); }

View all references View on Trac View on GitHub

Uses	Description
WP_REST_Server::set_status()`wp-includes/rest-api/class-wp-rest-server.php`	Sends an HTTP status code.
wp_json_encode()`wp-includes/functions.php`	Encodes a variable into JSON, with some confidence checks.

Used by	Description
WP_REST_Server::serve_request()`wp-includes/rest-api/class-wp-rest-server.php`	Handles serving a REST API request.

Changelog

Version	Description
4.4.0	Introduced.

User Contributed Notes

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