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.
Built from https://develop.svn.wordpress.org/trunk@53809


git-svn-id: http://core.svn.wordpress.org/trunk@53368 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2022-08-01 11:15:14 +00:00
parent 7c316c4f1a
commit a3a299ce1e
2 changed files with 16 additions and 5 deletions

View File

@ -370,9 +370,9 @@ function current_filter() {
/**
* 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
* (regardless of whether it's the most recent filter to fire, in the case of
@ -381,7 +381,7 @@ function current_filter() {
* @since 3.9.0
*
* @see current_filter()
* @see did_action()
* @see did_filter()
* @global string[] $wp_current_filter Current filter.
*
* @param string|null $hook_name Optional. Filter hook to check. Defaults to null,
@ -641,8 +641,19 @@ function current_action() {
/**
* 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,
* which checks if any action is currently being run.
* @return bool Whether the action is currently in the stack.

View File

@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.1-alpha-53808';
$wp_version = '6.1-alpha-53809';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.