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

Send a JSON response back to an Ajax request.


Parameters 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 value: null


Top ↑

Source Source

File: wp-includes/functions.php

function wp_send_json( $response, $status_code = null ) {
	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 );

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


Top ↑

Changelog Changelog

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

Top ↑

User Contributed Notes User Contributed Notes

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