WP_REST_Server::json_error( string $code, string $message, int $status = null )
Retrieves an appropriate error representation in JSON.
Description 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 Parameters
- $code
-
(string) (Required) WP_Error-style code.
- $message
-
(string) (Required) Human-readable message.
- $status
-
(int) (Optional) HTTP status code to send.
Default value: null
Return Return
(string) JSON representation of the error
Source Source
File: wp-includes/rest-api/class-wp-rest-server.php
protected function json_error( $code, $message, $status = null ) {
if ( $status ) {
$this->set_status( $status );
}
$error = compact( 'code', 'message' );
return wp_json_encode( $error );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |