WP_Customize_Manager::wp_die( string|WP_Error $ajax_message, string $message = null ): never
- Since
- 3.4.0
- Source
wp-includes/class-wp-customize-manager.php:452
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
$ajax_messagestring|WP_Error- Ajax return.
$messagestringoptional- UI message.Default:
null
Return value
never
Performance profile
How much work a call to WP_Customize_Manager::wp_die() 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
- 12–57
- Plugin surface
- None
- Called by
- 2
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 57.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below WP_Customize_Manager::wp_die()
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 · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Manager::wp_die() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!->doing_ajax() | 12 | ->doing_ajax(), wp_die() |
->doing_ajax() | 15 | ->doing_ajax(), wp_die(), wp_die() |
!->doing_ajax() | 16 | ->doing_ajax(), __(), wp_die() |
->doing_ajax() | 19 | ->doing_ajax(), wp_die(), __(), wp_die() |
!->doing_ajax() | 50 | ->doing_ajax(), ob_start(), wp_enqueue_scripts(), wp_print_scripts(), wp_customize_url(), ob_get_clean(), ob_start(), wp_json_encode(), ob_get_clean(), wp_remove_surrounding_empty_script_tags(), wp_get_inline_script_tag(), wp_die() |
->doing_ajax() | 53 | ->doing_ajax(), wp_die(), ob_start(), wp_enqueue_scripts(), wp_print_scripts(), wp_customize_url(), ob_get_clean(), ob_start(), wp_json_encode(), ob_get_clean(), wp_remove_surrounding_empty_script_tags(), wp_get_inline_script_tag(), wp_die() |
!->doing_ajax() | 54 | ->doing_ajax(), __(), ob_start(), wp_enqueue_scripts(), wp_print_scripts(), wp_customize_url(), ob_get_clean(), ob_start(), wp_json_encode(), ob_get_clean(), wp_remove_surrounding_empty_script_tags(), wp_get_inline_script_tag(), wp_die() |
->doing_ajax() | 57 | ->doing_ajax(), wp_die(), __(), ob_start(), wp_enqueue_scripts(), wp_print_scripts(), wp_customize_url(), ob_get_clean(), ob_start(), wp_json_encode(), ob_get_clean(), wp_remove_surrounding_empty_script_tags(), wp_get_inline_script_tag(), wp_die() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 57 instructions, 12–57 executed per call, 3 branches. The work does not change between versions.
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 · 9
- wp_die()Kills WordPress execution and displays HTML page with an error message.
- __()Retrieves the translation of $text.
- wp_enqueue_scripts()Wrapper for do_action( 'wp_enqueue_scripts' ).
- wp_print_scripts()Prints scripts in document head that are in the $handles queue.
- wp_customize_url()Returns a URL to load the Customizer.
- wp_json_encode()Encodes a variable into JSON, with some confidence checks.
- wp_get_inline_script_tag()Constructs an inline script tag.
- wp_remove_surrounding_empty_script_tags()Removes leading and trailing _empty_ script tags.
- WP_Customize_Manager::doing_ajax()Returns true if it's an Ajax request.
Used by · 2
- WP_Customize_Manager::customize_preview_init()Prints JavaScript settings.
- WP_Customize_Manager::setup_theme()Starts preview and customize theme.
Source code
protected function wp_die( $ajax_message, $message = null ) { if ( $this->doing_ajax() ) { wp_die( $ajax_message ); } if ( ! $message ) { $message = __( 'An error occurred while customizing. Please refresh the page and try again.' ); } if ( $this->messenger_channel ) { ob_start(); wp_enqueue_scripts(); wp_print_scripts( array( 'customize-base' ) ); $settings = array( 'messengerArgs' => array( 'channel' => $this->messenger_channel, 'url' => wp_customize_url(), ), 'error' => $ajax_message, ); $message .= ob_get_clean(); ob_start(); ?> <script> ( function( api, settings ) { var preview = new api.Messenger( settings.messengerArgs ); preview.send( 'iframe-loading-error', settings.error ); } )( wp.customize, <?php echo wp_json_encode( $settings, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ); ?> ); </script> <?php $message .= wp_get_inline_script_tag( wp_remove_surrounding_empty_script_tags( ob_get_clean() ) . "\n//# sourceURL=" . rawurlencode( __METHOD__ ) ); } wp_die( $message ); }Changelog
Introduced in 3.4.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
none to never.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/class-wp-customize-manager.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.