W3cubDocs

/WordPress

_ajax_wp_die_handler( string $message, string $title = , string|array $args = array() )

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

Description

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

Parameters

$messagestringrequired
Error message.
$titlestringoptional
Error title (unused).

Default:''

$argsstring|arrayoptional
Arguments to control behavior.

Default:array()

Source

function _ajax_wp_die_handler( $message, $title = '', $args = array() ) {
	// Set default 'response' to 200 for Ajax requests.
	$args = wp_parse_args(
		$args,
		array( 'response' => 200 )
	);

	list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );

	if ( ! headers_sent() ) {
		// This is intentional. For backward-compatibility, support passing null here.
		if ( null !== $args['response'] ) {
			status_header( $parsed_args['response'] );
		}
		nocache_headers();
	}

	if ( is_scalar( $message ) ) {
		$message = (string) $message;
	} else {
		$message = '0';
	}

	if ( $parsed_args['exit'] ) {
		die( $message );
	}

	echo $message;
}

Changelog

Version Description
3.4.0 Introduced.

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