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

Sends a JSON response back to an Ajax request.

Contents

Parameters
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes

Parameters

$response mixed Required: Variable (usually an array or object) to encode as JSON, then print and die.
$status_code int Optional: The HTTP status code to output.

Default: null
$options int Optional: Options to be passed to json_encode(). Default 0.

Source

File: wp-includes/functions.php. View all references

function wp_send_json( $response, $status_code = null, $options = 0 ) {
	if ( defined( 'REST_REQUEST' ) && 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, $options );

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

View on Trac View on GitHub

Uses

Uses
Uses	Description
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 sanity checks.
__() wp-includes/l10n.php	Retrieves the translation of $text.
_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 5 more uses Hide more uses

Used By

Used By
Used By	Description
wp_ajax_heartbeat() wp-admin/includes/ajax-actions.php	Ajax handler for the Heartbeat API.
wp_ajax_nopriv_heartbeat() wp-admin/includes/ajax-actions.php	Ajax handler for the Heartbeat API in the no-privilege context.
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

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

User Contributed Notes

Skip to note 1 content

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

Contributed by Aurovrata Venet — 3 years ago
```
<?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 2 content

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

Contributed by rmdundon — 3 years ago

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

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