Changeset 44674 for trunk/src/wp-includes/class-wp-fatal-error-handler.php

Timestamp:

01/21/2019 08:14:56 PM (7 years ago)

Author:

flixos90

Message:

Bootstrap/Load: Change shutdown handler naming to final fatal error handler and allow disabling the handler entirely via a constant.

The WP_Shutdown_Handler name plus related function names were premature when originally committed, as there can be multiple shutdown handlers in PHP, and WordPress makes use of that feature. This changeset modifies the name to a more appropriate WP_Fatal_Error_Handler, and related to that changes the following names:

• The drop-in to override the handler is now called fatal-error-handler.php.
• The internal function wp_register_premature_shutdown_handler is now called wp_register_fatal_error_handler().

In addition to these naming changes, a new constant WP_DISABLE_FATAL_ERROR_HANDLER is introduced that can be set in wp-config.php to entirely disable the fatal error handler. That constant's value is and should be accessed indirectly via a new wp_is_fatal_error_handler_enabled() function and is filterable via a new wp_fatal_error_handler_enabled hook. Note that disabling the fatal error handler will skip the new functionality entirely, including the potentially used fatal-error-handler.php drop-in.

The new set of constant, filter and function provide for an easier-to-use mechanism to disable the fatal error handler altogether, rather than requiring developers to implement a drop-in for purely that purpose.

Props afragen, flixos90, joyously, knutsp, markjaquith, ocean90, schlessera, spacedmonkey.
Fixes #46047. See #44458.

File:

• trunk/src/wp-includes/class-wp-fatal-error-handler.php (moved) (moved from trunk/src/wp-includes/class-wp-shutdown-handler.php) (3 diffs)

trunk/src/wp-includes/class-wp-fatal-error-handler.php

@@ -1 +1 @@
 <?php
 /**
- * Error Protection API: WP_Shutdown_Handler class
+ * Error Protection API: WP_Fatal_Error_Handler class
  *
  * @package WordPress
@@ -8 +8 @@
 
 /**
- * Core class used as the default shutdown handler.
+ * Core class used as the default shutdown handler for fatal errors.
  *
- * A drop-in 'shutdown-handler.php' can be used to override the instance of this class and use a custom implementation
- * for the shutdown handler that WordPress registers. The custom class should extend this class and can override its
- * methods individually as necessary. The file must return the instance of the class that should be registered.
+ * A drop-in 'fatal-error-handler.php' can be used to override the instance of this class and use a custom
+ * implementation for the fatal error handler that WordPress registers. The custom class should extend this class and
+ * can override its methods individually as necessary. The file must return the instance of the class that should be
+ * registered.
  *
  * @since 5.1.0
  */
-class WP_Shutdown_Handler {
+class WP_Fatal_Error_Handler {
 
     /**
@@ -127 +128 @@
      * `wp-includes/load.php` should be checked for before being called.
      *
-     * If no such drop-in is available, this will call {@see WP_Shutdown_Handler::display_default_error_template()}.
+     * If no such drop-in is available, this will call {@see WP_Fatal_Error_Handler::display_default_error_template()}.
      *
      * @since 5.1.0