WP_Fatal_Error_Handler::display_default_error_template( array $error, true|WP_Error $handled )

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

$errorarray

Error information retrieved from error_get_last().

$handledtrue|WP_Error

Whether Recovery Mode handled the fatal error.

Performance profile

How much work a call to WP_Fatal_Error_Handler::display_default_error_template() 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

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

61–92

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

Plugin surface

2 hooks

Third-party callbacks on 'wp_php_error_message', 'wp_php_error_args' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize 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 · 18 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while WP_Fatal_Error_Handler::display_default_error_template() runs, in this order:

1. 1
   apply_filters( wp_php_error_message )filterline 224 (+50 into the body)

   Filters the message that the default PHP error template displays.

2. 2
   apply_filters( wp_php_error_args )filterline 235 (+61 into the body)

   Filters the arguments passed to {@see wp_die()} for the default PHP error template.

Uses · 10

• wp_load_translations_early()Attempts an early load of translations.
• wp_is_recovery_mode()Determines whether WordPress is in Recovery Mode.
• __()Retrieves the translation of $text.
• is_protected_endpoint()Determines whether we are currently on an endpoint that should be protected against WSODs.
• wp_recovery_mode()Access the WordPress Recovery Mode instance.
• is_multisite()Determines whether Multisite is enabled.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_die()Kills WordPress execution and displays HTML page with an error message.
• wp_recovery_mode()::is_initialized()
• WP_Error::__construct()Initializes the error.

Used by · 1

• WP_Fatal_Error_Handler::display_error_template()Displays the PHP error template and sends the HTTP status code, typically 500.

Source code

View on Trac ↗View on GitHub ↗

174	protected function display_default_error_template( $error, $handled ) {175		if ( ! function_exists( '__' ) ) {176			wp_load_translations_early();177		}178 179		if ( ! function_exists( 'wp_die' ) ) {180			require_once ABSPATH . WPINC . '/functions.php';181		}182 183		if ( ! class_exists( 'WP_Error' ) ) {184			require_once ABSPATH . WPINC . '/class-wp-error.php';185		}186 187		if ( true === $handled && wp_is_recovery_mode() ) {188			$message = __( 'There has been a critical error on this website, putting it in recovery mode. Please check the Themes and Plugins screens for more details. If you just installed or updated a theme or plugin, check the relevant page for that first.' );189		} elseif ( is_protected_endpoint() && wp_recovery_mode()->is_initialized() ) {190			if ( is_multisite() ) {191				$message = __( 'There has been a critical error on this website. Please reach out to your site administrator, and inform them of this error for further assistance.' );192			} else {193				$message = sprintf(194					/* translators: %s: Support forums URL. */195					__( 'There has been a critical error on this website. Please check your site admin email inbox for instructions. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),196					__( 'https://wordpress.org/support/forums/' )197				);198			}199		} else {200			$message = __( 'There has been a critical error on this website.' );201		}202 203		$message = sprintf(204			'<p>%s</p><p><a href="%s">%s</a></p>',205			$message,206			/* translators: Documentation about troubleshooting. */207			__( 'https://wordpress.org/documentation/article/faq-troubleshooting/' ),208			__( 'Learn more about troubleshooting WordPress.' )209		);210 211		$args = array(212			'response' => 500,213			'exit'     => false,214		);215 216		/**217		 * Filters the message that the default PHP error template displays.218		 *219		 * @since 5.2.0220		 *221		 * @param string $message HTML error message to display.222		 * @param array  $error   Error information retrieved from `error_get_last()`.223		 */224		$message = apply_filters( 'wp_php_error_message', $message, $error );225 226		/**227		 * Filters the arguments passed to {@see wp_die()} for the default PHP error template.228		 *229		 * @since 5.2.0230		 *231		 * @param array $args Associative array of arguments passed to `wp_die()`. By default these contain a232		 *                    'response' key, and optionally 'link_url' and 'link_text' keys.233		 * @param array $error Error information retrieved from `error_get_last()`.234		 */235		$args = apply_filters( 'wp_php_error_args', $args, $error );236 237		$wp_error = new WP_Error(238			'internal_server_error',239			$message,240			array(241				'error' => $error,242			)243		);244 245		wp_die( $wp_error, '', $args );246	}

Changelog

Introduced in 5.2.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 7.1.0 tag, from src/wp-includes/class-wp-fatal-error-handler.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.