_ajax_wp_die_handler( string $message, string $title = '', string|array $args = array() )
- Since
- 3.4.0
- Source
wp-includes/functions.php:4069
Description
This is the handler for wp_die() when processing Ajax requests.
Compatibility
- WordPress
- since 3.4.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$messagestring- Error message.
$titlestringoptional- Error title (unused). Default empty string.Default:
'' $argsstring|arrayoptional- Arguments to control behavior. Default empty array.Default:
array()
Performance profile
How much work a call to _ajax_wp_die_handler() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 29–44
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 45.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()one call below _ajax_wp_die_handler()
Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _ajax_wp_die_handler() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
headers_sent() && !$parsed_args | 29–31 | wp_parse_args(), _wp_die_process_input(), headers_sent() |
headers_sent() && $parsed_args | 32–34 | wp_parse_args(), _wp_die_process_input(), headers_sent(), exit() |
!headers_sent() && !$parsed_args | 34–36 | wp_parse_args(), _wp_die_process_input(), headers_sent(), nocache_headers() |
!headers_sent() && $parsed_args | 37–39 | wp_parse_args(), _wp_die_process_input(), headers_sent(), nocache_headers(), exit() |
!headers_sent() && !$parsed_args | 39–41 | wp_parse_args(), _wp_die_process_input(), headers_sent(), status_header(), nocache_headers() |
!headers_sent() && $parsed_args | 42–44 | wp_parse_args(), _wp_die_process_input(), headers_sent(), status_header(), nocache_headers(), exit() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 45 | 29–44 | 4 | |
| 8.5 | 45 | 29–44 | 4 | |
| 8.4 | 45 | 29–44 | 4 | 2 more instructions than PHP 8.3 |
| 8.3 | 43 | 28–41 | 4 | |
| 8.2 | 43 | 28–41 | 4 | 1 fewer instruction than PHP 8.1 |
| 8.1 | 44 | 29–42 | 4 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 46 | 31–44 | 4 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- wp_parse_args()Merges user defined arguments into defaults array.
- _wp_die_process_input()Processes arguments passed to wp_die() consistently for its handlers.
- status_header()Sets HTTP status header.
- nocache_headers()Sets the HTTP headers to prevent caching for the different browsers.
Source code
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
Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 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.