Checks whether the template should be output buffered for enhancement.
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.
Source
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 'wp_template_enhancement_output_buffer' filter has been
* added or if a plugin has added a '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
* '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' ) );
}
Hooks
- apply_filters( ‘wp_should_output_buffer_template_for_enhancement’,
bool $use_output_buffer ) Filters whether the template should be output-buffered for enhancement.
Changelog
| Version | Description |
|---|---|
| 6.9.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.