Changeset 50811

Timestamp:

05/04/2021 03:00:33 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Further synchronize documentation for some Plugin API functions.

Follow-up to [50807].

See #50531.

Location:

trunk/src/wp-includes

Files:

• class-wp-hook.php (modified) (4 diffs)
• plugin.php (modified) (2 diffs)

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

@@ -51 +51 @@
 
         /**
-         * Flag for if we're current doing an action, rather than a filter.
+         * Flag for if we're currently doing an action, rather than a filter.
          *
          * @since 4.7.0
@@ -59 +59 @@
 
         /**
-         * Adds a callback function to the specified filter hook.
+         * Adds a callback function to a filter hook.
          *
          * @since 4.7.0
@@ -65 +65 @@
          * @param string   $hook_name     The name of the filter to add the callback to.
          * @param callable $callback      The callback to be run when the filter is applied.
-         * @param int      $priority      The order in which the functions associated with a particular action
+         * @param int      $priority      The order in which the functions associated with a particular filter
          *                                are executed. Lower numbers correspond with earlier execution,
          *                                and functions with the same priority are executed in the order
-         *                                in which they were added to the action.
+         *                                in which they were added to the filter.
          * @param int      $accepted_args The number of arguments the function accepts.
          */
@@ -165 +165 @@
 
         /**
-         * Removes a callback function from the specified filter hook.
+         * Removes a callback function from a filter hook.
          *
          * @since 4.7.0

trunk/src/wp-includes/plugin.php

@@ -280 +280 @@
  * @param string   $hook_name The filter hook to which the function to be removed is hooked.
  * @param callable $callback  The name of the function which should be removed.
- * @param int      $priority  Optional. The priority of the function. Default 10.
+ * @param int      $priority  Optional. The exact priority used when adding the original
+ *                            filter callback. Default 10.
  * @return bool Whether the function existed before it was removed.
  */
@@ -554 +555 @@
  * @param string   $hook_name The action hook to which the function to be removed is hooked.
  * @param callable $callback  The name of the function which should be removed.
- * @param int      $priority  Optional. The priority of the function. Default 10.
+ * @param int      $priority  Optional. The exact priority used when adding the original
+ *                            action callback. Default 10.
  * @return bool Whether the function is removed.
  */