doing_filter() WordPress Function
The doing_filter() function checks whether the current filter is being run. This function is useful for making sure that code only runs when a particular filter is being run.
doing_filter( null|string $hook_name = null ) #
Returns whether or not a filter hook is currently being processed.
Description
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 executed (regardless of whether it’s the most recent filter to fire, in the case of hooks called from hook callbacks) to be verified.
See also
Parameters
- $hook_name
(null|string)(Optional) Filter hook to check. Defaults to null, which checks if any filter is currently being run.
Default value: null
Return
(bool) Whether the filter is currently in the stack.
Source
File: wp-includes/plugin.php
function doing_filter( $hook_name = null ) {
global $wp_current_filter;
if ( null === $hook_name ) {
return ! empty( $wp_current_filter );
}
return in_array( $hook_name, $wp_current_filter, true );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.9.0 | Introduced. |