wp_send_json_success( mixed $data = null, int $status_code = null, int $options )

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

Parameters

$data

(mixed) (Optional) Data to encode as JSON, then print and die.

Default value: null

$status_code

(int) (Optional) The HTTP status code to output.

Default value: null

$options

(int) (Optional) Options to be passed to json_encode(). Default 0.

More Information

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

Example arrays such as the following are converted to JSON:

$response = array( 'success' => true );                   //if $data is empty
$response = array( 'success' => true, 'data' => $data );  //if $data is set

Source

File: wp-includes/functions.php

function wp_send_json_success( $data = null, $status_code = null, $options = 0 ) {
	$response = array( 'success' => true );

	if ( isset( $data ) ) {
		$response['data'] = $data;
	}

	wp_send_json( $response, $status_code, $options );
}

Changelog

Version Description
5.6.0 The $options parameter was added.
4.7.0 The $status_code parameter was added.
3.5.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_send_json_success