Changeset 49489 for trunk/src/wp-includes/class-wp-hook.php

Timestamp:

11/03/2020 05:34:20 PM (4 years ago)

Author:

johnbillion

Message:

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

Fixes #50134

File:

• trunk/src/wp-includes/class-wp-hook.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-hook.php

@@ -357 +357 @@
      * Normalizes filters set up before WordPress has initialized to WP_Hook objects.
      *
-     * @since 4.7.0
-     *
-     * @param array $filters Filters to normalize.
+     * 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
+     *
+     * @param array $filters Filters to normalize. See documentation above for details.
      * @return WP_Hook[] Array of normalized filters.
      */