vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

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

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

See #55646.

git-svn-id: https://develop.svn.wordpress.org/trunk@53809 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2022-08-01 11:13:13 +00:00
parent 299ac4dbb9
commit 10b2b084af
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/wp-includes/plugin.php
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.