Docs: Add more information about how to use filters that run before WordPress initialises.

Fixes #50134

Built from https://develop.svn.wordpress.org/trunk@49489


git-svn-id: http://core.svn.wordpress.org/trunk@49248 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2020-11-03 17:36:09 +00:00
parent 238e69d9a6
commit 3cee52b362
3 changed files with 44 additions and 2 deletions

View File

@ -356,9 +356,30 @@ final class WP_Hook implements Iterator, ArrayAccess {
/** /**
* Normalizes filters set up before WordPress has initialized to WP_Hook objects. * Normalizes filters set up before WordPress has initialized to WP_Hook objects.
* *
* The `$filters` parameter should be an array keyed by hook name, with values
* containing either:
*
* - A `WP_Hook` instance
* - An array of callbacks keyed by their priorities
*
* Examples:
*
* $filters = array(
* 'wp_fatal_error_handler_enabled' => array(
* 10 => array(
* array(
* 'accepted_args' => 0,
* 'function' => function() {
* return false;
* },
* ),
* ),
* ),
* );
*
* @since 4.7.0 * @since 4.7.0
* *
* @param array $filters Filters to normalize. * @param array $filters Filters to normalize. See documentation above for details.
* @return WP_Hook[] Array of normalized filters. * @return WP_Hook[] Array of normalized filters.
*/ */
public static function build_preinitialized_hooks( $filters ) { public static function build_preinitialized_hooks( $filters ) {

View File

@ -111,6 +111,27 @@ function wp_is_fatal_error_handler_enabled() {
/** /**
* Filters whether the fatal error handler is enabled. * Filters whether the fatal error handler is enabled.
* *
* **Important:** This filter runs before it can be used by plugins. It cannot
* be used by plugins, mu-plugins, or themes. To use this filter you must define
* a `$wp_filter` global before WordPress loads, usually in `wp-config.php`.
*
* Example:
*
* $GLOBALS['wp_filter'] = array(
* 'wp_fatal_error_handler_enabled' => array(
* 10 => array(
* array(
* 'accepted_args' => 0,
* 'function' => function() {
* return false;
* },
* ),
* ),
* ),
* );
*
* Alternatively you can use the `WP_DISABLE_FATAL_ERROR_HANDLER` constant.
*
* @since 5.2.0 * @since 5.2.0
* *
* @param bool $enabled True if the fatal error handler is enabled, false otherwise. * @param bool $enabled True if the fatal error handler is enabled, false otherwise.

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.6-beta3-49488'; $wp_version = '5.6-beta3-49489';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.