WordPress at a glance

wp_send_json_error() WP 1.0

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

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.

  • Since 4.1.0 The $data parameter is now processed if a WP_Error object is passed in.
  • Since 4.7.0 The $status_code parameter was added.
Works based on: wp_send_json()

No Hooks.

Return

Nothing (null).

Usage

wp_send_json_error( $data, $status_code );
$data(mixed)
Data to encode as JSON, then print and die.
Default: null
$status_code(int)
The HTTP status code to output.
Default: null

Code of wp_send_json_error: wp-includes/functions.php VER 5.0

<?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 );
}

Related Functions

From tag: AJAX

More from category: Helper Functions

No comments
    Hello, !     Log In . Register