wp_send_json_success() WordPress Function

The wp_send_json_success() function is used to return a JSON response to the browser when a WordPress Ajax request is successful. This function takes one parameter, which is an array of data that will be converted to JSON and sent to the browser.

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.


Top ↑

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

Top ↑

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


Top ↑

Changelog

Changelog
VersionDescription
5.6.0The $options parameter was added.
4.7.0The $status_code parameter was added.
3.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More