Walker_Comment::comment( WP_Comment $comment, int $depth, array $args )
- Since
- 3.6.0
- Source
wp-includes/class-walker-comment.php:299
Outputs a single comment.
Compatibility
- WordPress
- since 3.6.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
$commentWP_Comment- Comment to display.
$depthint- Depth of the current comment.
$argsarray- An array of arguments.
Performance profile
How much work a call to Walker_Comment::comment() 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
- Moderate
- Scaling
- Constant
- Instructions
- 131–156
- Plugin surface
- None
- Called by
- 1
Reads stored settings via get_option(), cached per request but not free on a cold cache.
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 163.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below Walker_Comment::comment() - optionoption read or write
get_option()one call below Walker_Comment::comment()
Further down the call graph this can also reach query, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost Walker_Comment::comment() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 131–141 | wp_get_current_commenter(), __(), comment_class(), comment_ID(), get_comment_author_link(), __(), printf(), get_comment_link(), esc_url(), __(), get_comment_date(), get_comment_time(), sprintf(), printf(), __(), edit_comment_link(), add_below(), array_merge(), add_below(), array_merge() |
| always | 135–145 | wp_get_current_commenter(), __(), comment_class(), comment_ID(), comment_ID(), get_comment_author_link(), __(), printf(), get_comment_link(), esc_url(), __(), get_comment_date(), get_comment_time(), sprintf(), printf(), __(), edit_comment_link(), add_below(), array_merge(), add_below(), array_merge() |
| always | 136–145 | wp_get_current_commenter(), __(), comment_class(), comment_ID(), get_comment_author_link(), get_comment_author(), __(), printf(), get_comment_link(), esc_url(), __(), get_comment_date(), get_comment_time(), sprintf(), printf(), __(), edit_comment_link(), add_below(), array_merge(), add_below(), array_merge() |
| always | 138–148 | wp_get_current_commenter(), __(), comment_class(), comment_ID(), get_avatar(), get_comment_author_link(), __(), printf(), get_comment_link(), esc_url(), __(), get_comment_date(), get_comment_time(), sprintf(), printf(), __(), edit_comment_link(), add_below(), array_merge(), add_below(), array_merge() |
| always | 140–149 | wp_get_current_commenter(), __(), comment_class(), comment_ID(), comment_ID(), get_comment_author_link(), get_comment_author(), __(), printf(), get_comment_link(), esc_url(), __(), get_comment_date(), get_comment_time(), sprintf(), printf(), __(), edit_comment_link(), add_below(), array_merge(), add_below(), array_merge() |
| always | 142–152 | wp_get_current_commenter(), __(), comment_class(), comment_ID(), comment_ID(), get_avatar(), get_comment_author_link(), __(), printf(), get_comment_link(), esc_url(), __(), get_comment_date(), get_comment_time(), sprintf(), printf(), __(), edit_comment_link(), add_below(), array_merge(), add_below(), array_merge() |
| always | 143–152 | wp_get_current_commenter(), __(), comment_class(), comment_ID(), get_avatar(), get_comment_author_link(), get_comment_author(), __(), printf(), get_comment_link(), esc_url(), __(), get_comment_date(), get_comment_time(), sprintf(), printf(), __(), edit_comment_link(), add_below(), array_merge(), add_below(), array_merge() |
| always | 147–156 | wp_get_current_commenter(), __(), comment_class(), comment_ID(), comment_ID(), get_avatar(), get_comment_author_link(), get_comment_author(), __(), printf(), get_comment_link(), esc_url(), __(), get_comment_date(), get_comment_time(), sprintf(), printf(), __(), edit_comment_link(), add_below(), array_merge(), add_below(), array_merge() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 164 | 132–157 | 10 | 1 more instruction than PHP 8.5 |
| 8.5 | 163 | 131–156 | 10 | |
| 8.4 | 163 | 131–156 | 10 | 1 fewer instruction than PHP 8.3 |
| 8.3 | 164 | 132–157 | 10 | |
| 8.2 | 164 | 132–157 | 10 | |
| 8.1 | 164 | 132–157 | 10 | |
| 7.4 | 164 | 132–157 | 10 |
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 · 14
- wp_get_current_commenter()Gets current commenter's name, email, and URL.
- __()Retrieves the translation of $text.
- comment_class()Generates semantic classes for each comment element.
- comment_ID()Displays the comment ID of the current comment.
- get_avatar()Retrieves the avatar `` tag for a user, email address, MD5 hash, comment, or post.
- get_comment_author_link()Retrieves the HTML link to the URL of the author of the current comment.
- get_comment_author()Retrieves the author of the current comment.
- esc_url()Checks and cleans a URL.
- get_comment_link()Retrieves the link to a given comment.
- get_comment_date()Retrieves the comment date of the current comment.
- get_comment_time()Retrieves the comment time of the current comment.
- edit_comment_link()Displays the edit comment link with formatting.
Show all 14
- comment_text()Displays the text of the current comment.
- comment_reply_link()Displays the HTML content for reply to comment link.
Used by · 1
- Walker_Comment::start_el()Starts the element output.
Source code
protected function comment( $comment, $depth, $args ) { if ( 'div' === $args['style'] ) { $tag = 'div'; $add_below = 'comment'; } else { $tag = 'li'; $add_below = 'div-comment'; } $commenter = wp_get_current_commenter(); $show_pending_links = isset( $commenter['comment_author'] ) && $commenter['comment_author']; if ( $commenter['comment_author_email'] ) { $moderation_note = __( 'Your comment is awaiting moderation.' ); } else { $moderation_note = __( 'Your comment is awaiting moderation. This is a preview; your comment will be visible after it has been approved.' ); } ?> <<?php echo $tag; ?> <?php comment_class( $this->has_children ? 'parent' : '', $comment ); ?> id="comment-<?php comment_ID(); ?>"> <?php if ( 'div' !== $args['style'] ) : ?> <div id="div-comment-<?php comment_ID(); ?>" class="comment-body"> <?php endif; ?> <div class="comment-author vcard"> <?php if ( 0 !== $args['avatar_size'] ) { echo get_avatar( $comment, $args['avatar_size'] ); } ?> <?php $comment_author = get_comment_author_link( $comment ); if ( '0' === $comment->comment_approved && ! $show_pending_links ) { $comment_author = get_comment_author( $comment ); } printf( /* translators: %s: Comment author link. */ __( '%s <span class="says">says:</span>' ), sprintf( '<cite class="fn">%s</cite>', $comment_author ) ); ?> </div> <?php if ( '0' === $comment->comment_approved ) : ?> <em class="comment-awaiting-moderation"><?php echo $moderation_note; ?></em> <br /> <?php endif; ?> <div class="comment-meta commentmetadata"> <?php printf( '<a href="%s">%s</a>', esc_url( get_comment_link( $comment, $args ) ), sprintf( /* translators: 1: Comment date, 2: Comment time. */ __( '%1$s at %2$s' ), get_comment_date( '', $comment ), get_comment_time() ) ); edit_comment_link( __( '(Edit)' ), ' ', '' ); ?> </div> <?php comment_text( $comment, array_merge( $args, array( 'add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth'], ) ) ); ?> <?php comment_reply_link(Changelog
Introduced in 3.6.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.0.4 tag, from
src/wp-includes/class-walker-comment.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.