On this page
_ajax_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 Ajax response with an error message.
Description
This is the handler for wp_die() when processing Ajax requests.
Parameters
$messagestring Required-
Error message.
$titlestring Optional-
Error title (unused).
Default:
'' $argsstring|array Optional-
Arguments to control behavior.
Default:
array()
Source
File: wp-includes/functions.php. View all references
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;
}
Related
Uses
| Uses | Description |
|---|---|
| _wp_die_process_input() wp-includes/functions.php | Processes arguments passed to wp_die() consistently for its handlers. |
| status_header() wp-includes/functions.php | Sets HTTP status header. |
| nocache_headers() wp-includes/functions.php | Sets the headers to prevent caching for the different browsers. |
| wp_parse_args() wp-includes/functions.php | Merges user defined arguments into defaults array. |
Changelog
| Version | Description |
|---|---|
| 3.4.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_ajax_wp_die_handler