wp_should_output_buffer_template_for_enhancement(): bool
- Since
- 6.9.0
- Source
wp-includes/template.php:842
Description
By default, an output buffer is only started if a 'wp_template_enhancement_output_buffer' filter has been added by the time a template is included at the 'wp_before_include_template' action. This allows template responses to be streamed as much as possible when no template enhancements are registered to apply.
Compatibility
- WordPress
- since 6.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 3 of the 5 tracked releases, added in 6.9.0, and compiles on PHP 7.4 through 8.6-dev.
Return value
bool- Whether the template should be output-buffered for enhancement.
Performance profile
How much work a call to wp_should_output_buffer_template_for_enhancement() 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
- 10–14
- Plugin surface
- 1 hook
- Called by
- 2
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, depending on the branch taken. The body compiles to 14.
Third-party callbacks on 'wp_should_output_buffer_template_for_enhancement' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_should_output_buffer_template_for_enhancement() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
has_filter() | 10 | has_filter(), apply_filters() |
!has_filter() | 14 | has_filter(), has_action(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 14 instructions, 10–14 executed per call, 1 branch. The work does not change between versions.
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.
Hooks and filters fired · 1
One hook fires while wp_should_output_buffer_template_for_enhancement() runs, in this order:
- apply_filters( wp_should_output_buffer_template_for_enhancement )filterline 857 (+15 into the body)
Filters whether the template should be output-buffered for enhancement.
Uses · 3
- apply_filters()Calls the callback functions that have been added to a filter hook.
- has_filter()Checks if any filter has been registered for a hook.
- has_action()Checks if any action has been registered for a hook.
Used by · 2
- wp_load_classic_theme_block_styles_on_demand()Adds hooks to load block styles on demand in classic themes.
- wp_start_template_enhancement_output_buffer()Starts the template enhancement output buffer.
Source code
function wp_should_output_buffer_template_for_enhancement(): bool { /** * Filters whether the template should be output-buffered for enhancement. * * By default, an output buffer is only started if a {@see 'wp_template_enhancement_output_buffer'} filter has been * added or if a plugin has added a {@see 'wp_finalized_template_enhancement_output_buffer'} action. For this * default to apply, either of the hooks must be added by the time the template is included at the * {@see 'wp_before_include_template'} action. This allows template responses to be streamed unless the there is * code which depends on an output buffer being opened. This filter allows a site to opt in to adding such template * enhancement filters later during the rendering of the template. * * @since 6.9.0 * * @param bool $use_output_buffer Whether an output buffer is started. */ return (bool) apply_filters( 'wp_should_output_buffer_template_for_enhancement', has_filter( 'wp_template_enhancement_output_buffer' ) || has_action( 'wp_finalized_template_enhancement_output_buffer' ) );}Changelog
Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.
Signature, return type and hooks compared across 3 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/template.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.