W3cubDocs

/WordPress

_json_wp_die_handler( string $message, string $title = '', string|array $args = array() )

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Kills WordPress execution and displays JSON response with an error message.

Description

This is the handler for wp_die() when processing JSON requests.

Parameters

$message

(string) (Required) Error message.

$title

(string) (Optional) Error title.

Default value: ''

$args

(string|array) (Optional) Arguments to control behavior.

Default value: array()

Source

File: wp-includes/functions.php 

function _json_wp_die_handler( $message, $title = '', $args = array() ) {
	list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );

	$data = array(
		'code'              => $parsed_args['code'],
		'message'           => $message,
		'data'              => array(
			'status' => $parsed_args['response'],
		),
		'additional_errors' => $parsed_args['additional_errors'],
	);

	if ( ! headers_sent() ) {
		header( "Content-Type: application/json; charset={$parsed_args['charset']}" );
		if ( null !== $parsed_args['response'] ) {
			status_header( $parsed_args['response'] );
		}
		nocache_headers();
	}

	echo wp_json_encode( $data );
	if ( $parsed_args['exit'] ) {
		die();
	}
}

Uses

Uses Description
wp-includes/functions.php: _wp_die_process_input()

Processes arguments passed to wp_die() consistently for its handlers.
wp-includes/functions.php: wp_json_encode()

Encode a variable into JSON, with some sanity checks.
wp-includes/functions.php: status_header()

Set HTTP status header.
wp-includes/functions.php: nocache_headers()

Set the headers to prevent caching for the different browsers.

Changelog

Version Description
5.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_json_wp_die_handler