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
-
$codestring Required -
WP_Error-style code.
-
$messagestring Required -
Human-readable message.
-
$statusint Optional -
HTTP status code to send.
Default:
null
Return
string JSON representation of the error
Source
File: wp-includes/rest-api/class-wp-rest-server.php.
View all references
protected function json_error( $code, $message, $status = null ) {
if ( $status ) {
$this->set_status( $status );
}
$error = compact( 'code', 'message' );
return wp_json_encode( $error );
}
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |