wp_send_json_error

Send a JSON response back to an Ajax request, indicating failure.

Description

wp_send_json_error( (constant) $data = null, (null) $status_code = null ); 

If the $data parameter is a WP_Error object, the errors 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

  1. if ( !function_exists( 'wp_send_json_error' ) ) { 
  2.     require_once ABSPATH . WPINC . '/functions.php'; 
  3. } 
  4.   
  5. // Data to encode as JSON, then print and die. 
  6. $data = null; 
  7.   
  8. // The HTTP status code to output. 
  9. $status_code = null; 
  10.   
  11. // NOTICE! Understand what this does before running. 
  12. $result = wp_send_json_error($data, $status_code); 
  13.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/functions.php  
  1. function wp_send_json_error( $data = null, $status_code = null ) { 
  2.     $response = array( 'success' => false ); 
  3.  
  4.     if ( isset( $data ) ) { 
  5.         if ( is_wp_error( $data ) ) { 
  6.             $result = array(); 
  7.             foreach ( $data->errors as $code => $messages ) { 
  8.                 foreach ( $messages as $message ) { 
  9.                     $result[] = array( 'code' => $code, 'message' => $message ); 
  10.                 } 
  11.             } 
  12.  
  13.             $response['data'] = $result; 
  14.         } else { 
  15.             $response['data'] = $data; 
  16.         } 
  17.     } 
  18.  
  19.     wp_send_json( $response, $status_code ); 
  20. }