wp_send_json() – Function | Developer.WordPress.org

Sends a JSON response back to an Ajax request.

Parameters

$responsemixedrequired: Variable (usually an array or object) to encode as JSON, then print and die.
$status_codeintoptional: The HTTP status code to output.
Default:null
$flagsintoptional: Options to be passed to json_encode(). Default 0.

Source

function wp_send_json( $response, $status_code = null, $flags = 0 ) {
	if ( wp_is_serving_rest_request() ) {
		_doing_it_wrong(
			__FUNCTION__,
			sprintf(
				/* translators: 1: WP_REST_Response, 2: WP_Error */
				__( 'Return a %1$s or %2$s object from your callback when using the REST API.' ),
				'WP_REST_Response',
				'WP_Error'
			),
			'5.5.0'
		);
	}

	if ( ! headers_sent() ) {
		header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
		if ( null !== $status_code ) {
			status_header( $status_code );
		}
	}

	echo wp_json_encode( $response, $flags );

	if ( wp_doing_ajax() ) {
		wp_die(
			'',
			'',
			array(
				'response' => null,
			)
		);
	} else {
		die;
	}
}

View all references View on Trac View on GitHub

Uses	Description
wp_is_serving_rest_request()`wp-includes/functions.php`	Determines whether WordPress is currently serving a REST API request.
wp_doing_ajax()`wp-includes/load.php`	Determines whether the current request is a WordPress Ajax request.
status_header()`wp-includes/functions.php`	Sets HTTP status header.
wp_json_encode()`wp-includes/functions.php`	Encodes a variable into JSON, with some confidence checks.
_doing_it_wrong()`wp-includes/functions.php`	Marks something as being incorrectly called.
wp_die()`wp-includes/functions.php`	Kills WordPress execution and displays HTML page with an error message.
get_option()`wp-includes/option.php`	Retrieves an option value based on an option name.

Show 4 more Show less

Used by	Description
wp_ajax_heartbeat()`wp-admin/includes/ajax-actions.php`	Handles the Heartbeat API via AJAX.
wp_ajax_nopriv_heartbeat()`wp-admin/includes/ajax-actions.php`	Handles the Heartbeat API in the no-privilege context via AJAX .
wp_send_json_success()`wp-includes/functions.php`	Sends a JSON response back to an Ajax request, indicating success.
wp_send_json_error()`wp-includes/functions.php`	Sends a JSON response back to an Ajax request, indicating failure.

Changelog

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

User Contributed Notes

Skip to note 3 content

Aurovrata Venet 5 years ago

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
```
<?php
// .................
// nonce checks ....
// .................

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

wp_send_json($return);
```
NOTE: not need to include wp_die() or exit(0) after using wp_send_json() as it automatically calls wp_die() .
Log in to add feedback
Skip to note 4 content

rmdundon 5 years ago

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

If this is a REST response (i.e. via the REST API), use WP_REST_Response or WP_Error, instead.

Log in to add feedback

wp_send_json( mixed $response, int $status_code = null, int $flags )

In this article

Parameters

Source

Changelog

User Contributed Notes

wp_send_json( mixed $response, int $status_code = null, int $flags )

In this article

Parameters

Source

Related

Changelog

User Contributed Notes