WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_send_json_success()

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

In this article

Back to top

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

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 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

 * @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_success( $value = null, $status_code = null, $flags = 0 ) {
	$response = array( 'success' => true );

View all references View on Trac View on GitHub

Changelog

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

User Contributed Notes

  1. Skip to note 3 content
    Andrew Lima
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    Busy working on sending JSON requests back to Zapier, here’s an example to help people get started. You can send an associative array of any data you need to get returned/shown.

    wp_send_json_success( array( 
    'name' => 'Andrew', 
    'call' => 'From some API/trigger', 
    'variable' => $var,
), 200 );
  2. Skip to note 4 content
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note

    Basic Example

    jQuery( document ).ready( function() {

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

    save_field.php:

    // Bootstrap WP

$return = array(
	'message' => __( 'Saved', 'textdomain' ),
	'ID'      => 1
);
wp_send_json_success( $return );

You must log in before being able to contribute a note or feedback.