Alert: 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.
_ajax_wp_die_handler() WordPress Function
The _ajax_wp_die_handler() function is used to die gracefully when an AJAX call fails. This function is especially useful for handling AJAX calls that are made from within the WordPress admin area.
_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
- $message
(string)(Required)Error message.
- $title
(string)(Optional) Error title (unused).
Default value: ''
- $args
(string|array)(Optional) Arguments to control behavior.
Default value: array()
Source
File: wp-includes/functions.php
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;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.4.0 | Introduced. |