WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Customize_Manager::wp_die()

WP_Customize_Manager::wp_die( string|WP_Error $ajax_message, string $message = null )

In this article

Back to top

Custom wp_die wrapper. Returns either the standard message for UI or the Ajax message.

Parameters

$ajax_messagestring|WP_Errorrequired
Ajax return.
$messagestringoptional
UI message.

Default:null

Source

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 ); ?> );	</script>	<?php	$message .= wp_get_inline_script_tag( wp_remove_surrounding_empty_script_tags( ob_get_clean() ) );	}	wp_die( $message ); }

View all references View on Trac View on GitHub

UsesDescription
wp_remove_surrounding_empty_script_tags()wp-includes/script-loader.php

Removes leading and trailing _empty_ script tags.

wp_get_inline_script_tag()wp-includes/script-loader.php

Constructs an inline script tag.

WP_Customize_Manager::doing_ajax()wp-includes/class-wp-customize-manager.php

Returns true if it’s an Ajax request.

wp_customize_url()wp-includes/theme.php

Returns a URL to load the Customizer.

wp_print_scripts()wp-includes/functions.wp-scripts.php

Prints scripts in document head that are in the $handles queue.

wp_enqueue_scripts()wp-includes/script-loader.php

Wrapper for do_action( ‘wp_enqueue_scripts’ ).

wp_json_encode()wp-includes/functions.php

Encodes a variable into JSON, with some confidence checks.

wp_die()wp-includes/functions.php

Kills WordPress execution and displays HTML page with an error message.

Show 3 moreShow less
Used byDescription
WP_Customize_Manager::customize_preview_init()wp-includes/class-wp-customize-manager.php

Prints JavaScript settings.

WP_Customize_Manager::setup_theme()wp-includes/class-wp-customize-manager.php

Starts preview and customize theme.

Changelog

VersionDescription
3.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.