Improve inline documentation for functionality in wp-includes/plugin.php added in 3.9.

See #14994, #27700.

Built from https://develop.svn.wordpress.org/trunk@28010


git-svn-id: http://core.svn.wordpress.org/trunk@27840 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-04-07 21:30:14 +00:00
parent 827b92a9bd
commit 4ed628a7c6
1 changed files with 10 additions and 8 deletions

View File

@ -328,6 +328,7 @@ function current_filter() {
* Retrieve the name of the current action.
*
* @since 3.9.0
*
* @uses current_filter()
*
* @return string Hook name of the current action.
@ -340,19 +341,19 @@ function current_action() {
* Retrieve the name of a filter 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. This function allows detection for any filter currently being
* being executed. did_action() returns true once the action is initially
* processed. This function allows detection for any filter currently being
* executed (despite not being the most recent filter to fire, in the case of
* hooks called from hook callbacks) to be verified.
*
* @since 3.9.0
*
* @see current_filter()
* @see did_action()
* @global array $wp_current_filter Current filter.
*
* @param string $filter Optional. Filter to check. Defaults to null, which checks if any filter is currently being run.
*
* @global array $wp_current_filter
*
* @param null|string $filter Optional. Filter to check. Defaults to null, which
* checks if any filter is currently being run.
* @return bool Whether the filter is currently in the stack
*/
function doing_filter( $filter = null ) {
@ -369,10 +370,11 @@ function doing_filter( $filter = null ) {
* Retrieve the name of an action currently being processed.
*
* @since 3.9.0
*
* @uses doing_filter()
*
* @param string $action Optional. Action to check. Defaults to null, which checks if any action is currently being run.
*
* @param string|null $action Optional. Action to check. Defaults to null, which checks
* if any action is currently being run.
* @return bool Whether the action is currently in the stack.
*/
function doing_action( $action = null ) {