Changeset 28886 for trunk/src/wp-includes/plugin.php

Timestamp:

06/28/2014 04:49:39 AM (11 years ago)

Author:

wonderboymusic

Message:

Update @param docs in plugin.php

Props dkotter.
Fixes #28516.

File:

• trunk/src/wp-includes/plugin.php (modified) (6 diffs)

trunk/src/wp-includes/plugin.php

@@ -94 +94 @@
  *
  * @param string $tag The name of the filter hook.
- * @param callback $function_to_check optional.
+ * @param bool|callback $function_to_check optional.
  * @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything registered.
  *  When checking a specific function, the priority of that hook is returned, or false if the function is not attached.
@@ -270 +270 @@
  * @param callback $function_to_remove The name of the function which should be removed.
  * @param int $priority optional. The priority of the function (default: 10).
- * @param int $accepted_args optional. The number of arguments the function accepts (default: 1).
  * @return boolean Whether the function existed before it was removed.
  */
@@ -298 +297 @@
  *
  * @param string $tag The filter to remove hooks from.
- * @param int $priority The priority number to remove.
+ * @param bool|int $priority The priority number to remove.
  * @return bool True when finished.
  */
@@ -404 +403 @@
  * @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). 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.
  * @param int $accepted_args optional. The number of arguments the function accept (default 1).
+ * @return bool Will always return true.
  */
 function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
@@ -565 +565 @@
  *
  * @param string $tag The name of the action hook.
- * @param callback $function_to_check optional.
+ * @param bool|callback $function_to_check optional.
  * @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything registered.
  *  When checking a specific function, the priority of that hook is returned, or false if the function is not attached.
@@ -599 +599 @@
  *
  * @param string $tag The action to remove hooks from.
- * @param int $priority The priority number to remove them from.
+ * @param bool|int $priority The priority number to remove them from.
  * @return bool True when finished.
  */