_default_wp_die_handler( string|WP_Error $message, string $title = '', string|array $args = array() )

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$messagestring|WP_Error

Error message or WP_Error object.

$titlestringoptional

Error title. Default empty string.Default: ''

$argsstring|arrayoptional

Arguments to control behavior. Default empty array.Default: array()

Performance profile

How much work a call to _default_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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

33–139

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 160.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()one call below _default_wp_die_handler()
• optionoption read or writeget_option()one call below _default_wp_die_handler()

Further down the call graph this can also reach 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 · 300 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _default_wp_die_handler() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 11

• _wp_die_process_input()Processes arguments passed to wp_die() consistently for its handlers.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• esc_url()Checks and cleans a URL.
• __()Retrieves the translation of $text.
• did_action()Retrieves the number of times an action has been fired during the current request.
• status_header()Sets HTTP status header.
• nocache_headers()Sets the HTTP headers to prevent caching for the different browsers.
• get_language_attributes()Gets the language attributes for the 'html' tag.
• add_filter()Adds a callback function to a filter hook.
• remove_filter()Removes a callback function from a filter hook.
• wp_robots()Displays the robots meta tag as necessary.

Source code

View on Trac ↗View on GitHub ↗

3855function _default_wp_die_handler( $message, $title = '', $args = array() ) {3856	list( $message, $title, $parsed_args ) = _wp_die_process_input( $message, $title, $args );3857 3858	if ( is_string( $message ) ) {3859		if ( ! empty( $parsed_args['additional_errors'] ) ) {3860			$message = array_merge(3861				array( $message ),3862				wp_list_pluck( $parsed_args['additional_errors'], 'message' )3863			);3864			$message = "<ul>\n\t\t<li>" . implode( "</li>\n\t\t<li>", $message ) . "</li>\n\t</ul>";3865		}3866 3867		$message = sprintf(3868			'<div class="wp-die-message">%s</div>',3869			$message3870		);3871	}3872 3873	$have_gettext = function_exists( '__' );3874 3875	if ( ! empty( $parsed_args['link_url'] ) && ! empty( $parsed_args['link_text'] ) ) {3876		$link_url = $parsed_args['link_url'];3877		if ( function_exists( 'esc_url' ) ) {3878			$link_url = esc_url( $link_url );3879		}3880		$link_text = $parsed_args['link_text'];3881		$message  .= "\n<p><a href='{$link_url}'>{$link_text}</a></p>";3882	}3883 3884	if ( isset( $parsed_args['back_link'] ) && $parsed_args['back_link'] ) {3885		$back_text = $have_gettext ? __( '&laquo; Back' ) : '&laquo; Back';3886		$message  .= "\n<p><a href='javascript:history.back()'>$back_text</a></p>";3887	}3888 3889	if ( ! did_action( 'admin_head' ) ) :3890		if ( ! headers_sent() ) {3891			header( "Content-Type: text/html; charset={$parsed_args['charset']}" );3892			status_header( $parsed_args['response'] );3893			nocache_headers();3894		}3895 3896		$text_direction = $parsed_args['text_direction'];3897		$dir_attr       = "dir='$text_direction'";3898 3899		/*3900		 * If `text_direction` was not explicitly passed,3901		 * use get_language_attributes() if available.3902		 */3903		if ( empty( $args['text_direction'] )3904			&& function_exists( 'language_attributes' ) && function_exists( 'is_rtl' )3905		) {3906			$dir_attr = get_language_attributes();3907		}3908		?>3909<!DOCTYPE html>3910<html <?php echo $dir_attr; ?>>3911<head>3912	<meta http-equiv="Content-Type" content="text/html; charset=<?php echo $parsed_args['charset']; ?>" />3913	<meta name="viewport" content="width=device-width, initial-scale=1.0">3914		<?php3915		if ( function_exists( 'wp_robots' ) && function_exists( 'wp_robots_no_robots' ) && function_exists( 'add_filter' ) ) {3916			add_filter( 'wp_robots', 'wp_robots_no_robots' );3917			// Prevent warnings because of $wp_query not existing.3918			remove_filter( 'wp_robots', 'wp_robots_noindex_embeds' );3919			remove_filter( 'wp_robots', 'wp_robots_noindex_search' );3920			wp_robots();3921		}3922		?>3923	<title><?php echo $title; ?></title>3924	<style type="text/css">3925		html {3926			background: #f1f1f1;3927		}3928		body {3929			background: #fff;3930			border: 1px solid #ccd0d4;3931			color: #444;3932			font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;3933			margin: 2em auto;3934			padding: 1em 2em;

Changelog

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 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.