doing_filter( string|null $hook_name = null ): bool
- Since
- 3.9.0
- Source
wp-includes/plugin.php:397
Description
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 hooks called from hook callbacks) to be verified.
Compatibility
- WordPress
- since 3.9.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$hook_namestring|nulloptional- Filter hook to check. Defaults to null, which checks if any filter is currently being run.Default:
null
Return value
bool- Whether the filter is currently in the stack.
Performance profile
How much work a call to doing_filter() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 7
- Plugin surface
- None
- Called by
- 5
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 10.
Nothing here hands control to plugin code.
5 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost doing_filter() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7 | none |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 10 | 7 | 1 | |
| 8.5 | 10 | 7 | 1 | |
| 8.4 | 10 | 7 | 1 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 13 | 7–10 | 1 | |
| 8.2 | 13 | 7–10 | 1 | |
| 8.1 | 13 | 7–10 | 1 | |
| 7.4 | 13 | 7–10 | 1 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Used by · 5
- _wp_filter_font_directory()A callback function for use in the {@see 'upload_dir'} filter.
- do_blocks()Parses dynamic blocks out of `post_content` and re-renders them.
- doing_action()Returns whether or not an action hook is currently being processed.
- wp_get_loading_attr_default()Gets the default value to use for a `loading` attribute on an element.
- wp_get_loading_optimization_attributes()Gets loading optimization attributes.
Source code
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 );}Changelog
Introduced in 3.9.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/plugin.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.