wp_send_json_error() – Function | Developer.WordPress.org

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

Description

If the $value 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

$valuemixedoptional: Data to encode as JSON, then print and die.
Default:null
$status_codeintoptional: The HTTP status code to output.
Default:null
$flagsintoptional: Options to be passed to json_encode(). Default 0.

More Information

The response object will always have a success key with the value false. If anything is passed to the function in the $data parameter, it will be encoded as the value for a data key.

Source

 * @since 4.7.0 The `$status_code` parameter was added.
 * @since 5.6.0 The `$flags` parameter was added.
 *
 * @param mixed $value       Optional. Data to encode as JSON, then print and die. Default null.
 * @param int   $status_code Optional. The HTTP status code to output. Default null.
 * @param int   $flags       Optional. Options to be passed to json_encode(). Default 0.
 */
function wp_send_json_error( $value = null, $status_code = null, $flags = 0 ) {
	$response = array( 'success' => false );

	if ( isset( $value ) ) {
		if ( is_wp_error( $value ) ) {
			$result = array();
			foreach ( $value->errors as $code => $messages ) {
				foreach ( $messages as $message ) {
					$result[] = array(
						'code'    => $code,
						'message' => $message,
					);
				}
			}

			$response['data'] = $result;

View all references View on Trac View on GitHub

Changelog

Version	Description
5.6.0	The `$flags` parameter was added.
4.7.0	The `$status_code` parameter was added.
4.1.0	The `$value` parameter is now processed if a WP_Error object is passed in.
3.5.0	Introduced.

User Contributed Notes

Skip to note 4 content

milossh 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 10You must log in to vote on the helpfulness of this note

Doing just wp_send_json_error(); won’t send error – it will actually return 200 instead. So, if you want to avoid AJAX’ success and trigger error, make sure to add error code, like 500, or whatever you prefer.

Log in to add feedback
Skip to note 5 content

mikelast 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
```
$error = new WP_Error( '001', 'No user information was retrieved.', 'Some information' );

wp_send_json_error( $error );
```
Log in to add feedback

Codex 9 years ago

-8

Example

jQuery( document ).ready( function() {

	jQuery( '#btn_save' ).on( 'click', function( event ) {
		event.preventDefault();
		jQuery.post( pluginUrl + 'ajax/save_field.php', jQuery( '#my-form' ).serialize(), function( data ) {						
			alert( data.success );
		} );
	} );
} );

save_field.php

<?php
$nonce = $_POST['_wpnonce_name'];
if ( empty( $_POST ) || ! wp_verify_nonce( $nonce, 'my-nonce' ) ) {
	wp_send_json_error(); // sends json_encoded success=false
}

wp_send_json_error( mixed $value = null, int $status_code = null, int $flags )

In this article