Changeset 49196

Timestamp:

10/18/2020 07:17:29 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Improve the docs for the globals that are used in the actions and filters API.

See #50531, #50768

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-importer.php (modified) (1 diff)
• wp-includes/plugin.php (modified) (13 diffs)

trunk/src/wp-admin/includes/class-wp-importer.php

@@ -262 +262 @@
      *
      * @global wpdb  $wpdb       WordPress database abstraction object.
-     * @global array $wp_actions
+     * @global int[] $wp_actions
      */
     public function stop_the_insanity() {

trunk/src/wp-includes/plugin.php

@@ -26 +26 @@
 
 /** @var WP_Hook[] $wp_filter */
-global $wp_filter, $wp_actions, $wp_current_filter;
+global $wp_filter;
+
+/** @var int[] $wp_actions */
+global $wp_actions;
+
+/** @var string[] $wp_current_filter */
+global $wp_current_filter;
 
 if ( $wp_filter ) {
@@ -94 +100 @@
  * @since 0.71
  *
- * @global array $wp_filter A multidimensional array of all hooks and the callbacks hooked to them.
+ * @global WP_Hook[] $wp_filter A multidimensional array of all hooks and the callbacks hooked to them.
  *
  * @param string   $tag             The name of the filter to hook the $function_to_add callback to.
@@ -120 +126 @@
  * @since 2.5.0
  *
- * @global array $wp_filter Stores all of the filters and actions.
+ * @global WP_Hook[] $wp_filter Stores all of the filters and actions.
  *
  * @param string        $tag               The name of the filter hook.
@@ -171 +177 @@
  * @since 0.71
  *
- * @global array $wp_filter         Stores all of the filters and actions.
- * @global array $wp_current_filter Stores the list of current filters with the current one last.
+ * @global WP_Hook[] $wp_filter         Stores all of the filters and actions.
+ * @global string[]  $wp_current_filter Stores the list of current filters with the current one last.
  *
  * @param string $tag     The name of the filter hook.
@@ -219 +225 @@
  * functions hooked to `$tag` are supplied using an array.
  *
- * @global array $wp_filter         Stores all of the filters and actions.
- * @global array $wp_current_filter Stores the list of current filters with the current one last.
+ * @global WP_Hook[] $wp_filter         Stores all of the filters and actions.
+ * @global string[]  $wp_current_filter Stores the list of current filters with the current one last.
  *
  * @param string $tag  The name of the filter hook.
@@ -267 +273 @@
  * @since 1.2.0
  *
- * @global array $wp_filter Stores all of the filters and actions.
+ * @global WP_Hook[] $wp_filter Stores all of the filters and actions.
  *
  * @param string   $tag                The filter hook to which the function to be removed is hooked.
@@ -293 +299 @@
  * @since 2.7.0
  *
- * @global array $wp_filter Stores all of the filters and actions.
+ * @global WP_Hook[] $wp_filter Stores all of the filters and actions.
  *
  * @param string   $tag      The filter to remove hooks from.
@@ -317 +323 @@
  * @since 2.5.0
  *
- * @global array $wp_current_filter Stores the list of current filters with the current one last
+ * @global string[] $wp_current_filter Stores the list of current filters with the current one last
  *
  * @return string Hook name of the current filter or action.
@@ -352 +358 @@
  * @see current_filter()
  * @see did_action()
- * @global array $wp_current_filter Current filter.
+ * @global string[] $wp_current_filter Current filter.
  *
  * @param null|string $filter Optional. Filter to check. Defaults to null, which
@@ -434 +440 @@
  *              by adding it to the function signature.
  *
- * @global array $wp_filter         Stores all of the filters and actions.
- * @global array $wp_actions        Increments the amount of times action was triggered.
- * @global array $wp_current_filter Stores the list of current filters with the current one last.
+ * @global WP_Hook[] $wp_filter         Stores all of the filters and actions.
+ * @global int[]     $wp_actions        Stores the number of times each action was triggered.
+ * @global string[]  $wp_current_filter Stores the list of current filters with the current one last.
  *
  * @param string $tag    The name of the action to be executed.
@@ -486 +492 @@
  * @since 2.1.0
  *
- * @global array $wp_actions Increments the amount of times action was triggered.
+ * @global int[] $wp_actions Stores the number of times each action was triggered.
  *
  * @param string $tag The name of the action hook.
@@ -508 +514 @@
  * @see do_action() This function is identical, but the arguments passed to the
  *                  functions hooked to `$tag` are supplied using an array.
- * @global array $wp_filter         Stores all of the filters and actions.
- * @global array $wp_actions        Increments the amount of times action was triggered.
- * @global array $wp_current_filter Stores the list of current filters with the current one last.
+ *
+ * @global WP_Hook[] $wp_filter         Stores all of the filters and actions.
+ * @global int[]     $wp_actions        Stores the number of times each action was triggered.
+ * @global string[]  $wp_current_filter Stores the list of current filters with the current one last.
  *
  * @param string $tag  The name of the action to be executed.
@@ -866 +873 @@
  * @access private
  *
- * @global array $wp_filter Stores all of the filters and actions.
+ * @global WP_Hook[] $wp_filter Stores all of the filters and actions.
  *
  * @param array $args The collected parameters from the hook that was called.