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

Timestamp:

12/01/2021 01:20:36 PM (4 years ago)

Author:

johnbillion

Message:

Plugins: Correct the documented allowable types for to the $callback parameter of various hook related functions.

These functions don't require the callback to be a valid callable, therefore array and string are also valid types for this parameter.

Props malthert

Fixes #54440

File:

• trunk/src/wp-includes/class-wp-hook.php (modified) (2 diffs)

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

@@ -169 +169 @@
      * @since 4.7.0
      *
-     * @param string   $hook_name The filter hook to which the function to be removed is hooked.
-     * @param callable $callback  The callback to be removed from running when the filter is applied.
-     * @param int      $priority  The exact priority used when adding the original filter callback.
+     * @param string                $hook_name The filter hook to which the function to be removed is hooked.
+     * @param callable|string|array $callback  The callback to be removed from running when the filter is applied.
+     *                                         This method can be called unconditionally to speculatively remove
+     *                                         a callback that may or may not exist.
+     * @param int                   $priority  The exact priority used when adding the original filter callback.
      * @return bool Whether the callback existed before it was removed.
      */
@@ -202 +204 @@
      * @since 4.7.0
      *
-     * @param string         $hook_name Optional. The name of the filter hook. Default empty.
-     * @param callable|false $callback  Optional. The callback to check for. Default false.
+     * @param string                      $hook_name Optional. The name of the filter hook. Default empty.
+     * @param callable|string|array|false $callback  Optional. The callback to check for.
+     *                                               This method can be called unconditionally to speculatively check
+     *                                               a callback that may or may not exist. Default false.
      * @return bool|int If `$callback` is omitted, returns boolean for whether the hook has
      *                  anything registered. When checking a specific function, the priority