string $theme_template )
Filters the path to the theme template file used for the comments template.
The path to the theme template file.
comments_template filter can be used to load a custom template form a plugin which replaces the theme’s default comment template.
View all references
$include = apply_filters( 'comments_template', $theme_template );
Code example migrated from Codex:
A plugin can register as a content filter with the code:
my_plugin_comment_templateis the function WordPress should call when the
comment_template()function is called on the theme. Note that the filter function the plugin defines must return the a full path to a template file or the resulting page will be blank.
This is an example of loading a different comments template for a custom post type:
The example code will load the template file
reviews.phplocated in your plugins folder for CPT called
business; otherwise, the code uses default template.
This filter is broken/unworking on newer block themes, such as Twenty Twenty-Three.
A replacement to i.e. disable the comments “template” (aka block) would now be: