wp_send_json_error
Send a JSON response back to an Ajax request, indicating failure.
Description
If the $data
parameter is a WP_Error
object, the error
s within the object are processed and output as an array of error
codes and corresponding messages. All other types are output without further processing.
Parameters (2)
- 0. $data — Optional. (constant) =>
null
- Data to encode as JSON, then print and die.
- 1. $status_code — Optional. (null) =>
null
- The HTTP status code to output.
Usage
if ( !function_exists( 'wp_send_json_error' ) ) { require_once ABSPATH . WPINC . '/functions.php'; } // Data to encode as JSON, then print and die. $data = null; // The HTTP status code to output. $status_code = null; // NOTICE! Understand what this does before running. $result = wp_send_json_error($data, $status_code);
Defined (1)
The function is defined in the following location(s).
- /wp-includes/functions.php
- function wp_send_json_error( $data = null, $status_code = null ) {
- $response = array( 'success' => false );
- if ( isset( $data ) ) {
- if ( is_wp_error( $data ) ) {
- $result = array();
- foreach ( $data->errors as $code => $messages ) {
- foreach ( $messages as $message ) {
- $result[] = array( 'code' => $code, 'message' => $message );
- }
- }
- $response['data'] = $result;
- } else {
- $response['data'] = $data;
- }
- }
- wp_send_json( $response, $status_code );
- }