render_block_core_comment_template( array $attributes, string $content, WP_Block $block ): string
- Since
- 6.0.0
- Source
wp-includes/blocks/comment-template.php:104
core/comment-template block on the server.Compatibility
- WordPress
- since 6.0.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
$attributesarray- Block attributes.
$contentstring- Block default content.
$blockWP_Block- Block instance.
Return value
string- Returns the HTML representing the comments using the layout defined by the block's inner blocks.
Performance profile
How much work a call to render_block_core_comment_template() 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
- Heavy
- Scaling
- Constant
- Instructions
- 7–49
- Plugin surface
- None
- Called by
- 0
Reaches the database via get_post().
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 52.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- optionoption read or write
get_option()called directly - querycontent query
get_post()one call below render_block_core_comment_template() - hookthird-party callbacks
apply_filters()one call below render_block_core_comment_template() - cacheobject cache
wp_cache_get()one call below render_block_core_comment_template() - serializeserialisation
maybe_unserialize()one call below render_block_core_comment_template()
Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost render_block_core_comment_template() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($value) | 7 | none |
!empty($value) && post_password_required() | 14 | post_password_required() |
!empty($value) && !post_password_required() | 27 | post_password_required(), build_comment_query_vars_from_block(), ->get_comments() |
!empty($value) && !post_password_required() && $comment_order !== "desc" | 45 | post_password_required(), build_comment_query_vars_from_block(), ->get_comments(), get_option(), get_block_wrapper_attributes(), block_core_comment_template_render_comments(), sprintf() |
!empty($value) && !post_password_required() && $comment_order === "desc" | 49 | post_password_required(), build_comment_query_vars_from_block(), ->get_comments(), get_option(), array_reverse(), get_block_wrapper_attributes(), block_core_comment_template_render_comments(), sprintf() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 52 instructions, 7–49 executed per call, 4 branches. 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.
Uses · 6
- post_password_required()Determines whether the post requires password and whether a correct password has been provided.
- build_comment_query_vars_from_block()Helper function that constructs a comment query vars array from the passed block properties.
- get_option()Retrieves an option value based on an option name.
- get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.
- block_core_comment_template_render_comments()Function that recursively renders a list of nested comments.
- WP_Comment_Query::__construct()Constructor.
Source code
function render_block_core_comment_template( $attributes, $content, $block ) { // Bail out early if the post ID is not set for some reason. if ( empty( $block->context['postId'] ) ) { return ''; } if ( post_password_required( $block->context['postId'] ) ) { return; } $comment_query = new WP_Comment_Query( build_comment_query_vars_from_block( $block ) ); // Get an array of comments for the current post. $comments = $comment_query->get_comments(); if ( count( $comments ) === 0 ) { return ''; } $comment_order = get_option( 'comment_order' ); if ( 'desc' === $comment_order ) { $comments = array_reverse( $comments ); } $wrapper_attributes = get_block_wrapper_attributes(); return sprintf( '<ol %1$s>%2$s</ol>', $wrapper_attributes, block_core_comment_template_render_comments( $comments, $block ) );}Changelog
Introduced in 6.0.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/blocks/comment-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.