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

Parameters

$responsemixed

Variable (usually an array or object) to encode as JSON, then print and die.

$status_codeintoptional

The HTTP status code to output. Default null.Default: null

$flagsintoptional

Options to be passed to json_encode(). Default 0.Default: 0

Uses · 8

• wp_is_serving_rest_request()Determines whether WordPress is currently serving a REST API request.
• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• get_option()Retrieves an option value based on an option name.
• status_header()Sets HTTP status header.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.
• wp_doing_ajax()Determines whether the current request is a WordPress Ajax request.
• wp_die()Kills WordPress execution and displays HTML page with an error message.

Used by · 4

• wp_ajax_heartbeat()Handles the Heartbeat API via AJAX.
• wp_ajax_nopriv_heartbeat()Handles the Heartbeat API in the no-privilege context via AJAX .
• wp_send_json_error()Sends a JSON response back to an Ajax request, indicating failure.
• wp_send_json_success()Sends a JSON response back to an Ajax request, indicating success.

Source

View on Trac ↗View on GitHub ↗

4513function wp_send_json( $response, $status_code = null, $flags = 0 ) {4514	if ( wp_is_serving_rest_request() ) {4515		_doing_it_wrong(4516			__FUNCTION__,4517			sprintf(4518				/* translators: 1: WP_REST_Response, 2: WP_Error */4519				__( 'Return a %1$s or %2$s object from your callback when using the REST API.' ),4520				'WP_REST_Response',4521				'WP_Error'4522			),4523			'5.5.0'4524		);4525	}4526 4527	if ( ! headers_sent() ) {4528		header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );4529		if ( null !== $status_code ) {4530			status_header( $status_code );4531		}4532	}4533 4534	echo wp_json_encode( $response, $flags );4535 4536	if ( wp_doing_ajax() ) {4537		wp_die(4538			'',4539			'',4540			array(4541				'response' => null,4542			)4543		);4544	} else {4545		die;4546	}4547}

History

Introduced in 3.5.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.