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

Timestamp:

08/01/2022 11:13:13 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve description for doing_filter() and doing_action().

This corrects a note about did_action() return type, and brings more consistency between the two DocBlocks.

Follow-up to [27294], [53803].

See #55646.

File:

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

trunk/src/wp-includes/plugin.php

@@ -371 +371 @@
  * Returns whether or not a filter hook is currently being processed.
  *
- * The function current_filter() only returns the most recent filter or action
- * being executed. did_action() returns true once the action is initially
- * processed.
+ * The function current_filter() only returns the most recent filter being executed.
+ * did_filter() returns the number of times a filter has been applied during
+ * the current request.
  *
  * This function allows detection for any filter currently being executed
@@ -382 +382 @@
  *
  * @see current_filter()
- * @see did_action()
+ * @see did_filter()
  * @global string[] $wp_current_filter Current filter.
  *
@@ -642 +642 @@
  * Returns whether or not an action hook is currently being processed.
  *
+ * The function current_action() only returns the most recent action being executed.
+ * did_action() returns the number of times an action has been fired during
+ * the current request.
+ *
+ * This function allows detection for any action currently being executed
+ * (regardless of whether it's the most recent action to fire, in the case of
+ * hooks called from hook callbacks) to be verified.
+ *
  * @since 3.9.0
+ *
+ * @see current_action()
+ * @see did_action()
  *
  * @param string|null $hook_name Optional. Action hook to check. Defaults to null,