Walker_Comment::html5_comment( WP_Comment $comment, int $depth, array $args )

Compatibility

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::html5_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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

110–141

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 147.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below Walker_Comment::html5_comment()
• optionoption read or writeget_option()one call below Walker_Comment::html5_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::html5_comment() can have, taken from its control-flow graph on PHP 8.5.

Uses · 14

• wp_get_current_commenter()Gets current commenter's name, email, and URL.
• __()Retrieves the translation of $text.
• comment_ID()Displays the comment ID of the current comment.
• comment_class()Generates semantic classes for each comment element.
• 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_time()Retrieves the comment time of the current comment.
• get_comment_date()Retrieves the comment date of the current comment.
• edit_comment_link()Displays the edit comment link with formatting.

Used by · 1

• Walker_Comment::start_el()Starts the element output.

Source code

View on Trac ↗View on GitHub ↗

409	protected function html5_comment( $comment, $depth, $args ) {410		$tag = ( 'div' === $args['style'] ) ? 'div' : 'li';411 412		$commenter          = wp_get_current_commenter();413		$show_pending_links = ! empty( $commenter['comment_author'] );414 415		if ( $commenter['comment_author_email'] ) {416			$moderation_note = __( 'Your comment is awaiting moderation.' );417		} else {418			$moderation_note = __( 'Your comment is awaiting moderation. This is a preview; your comment will be visible after it has been approved.' );419		}420		?>421		<<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class( $this->has_children ? 'parent' : '', $comment ); ?>>422			<article id="div-comment-<?php comment_ID(); ?>" class="comment-body">423				<footer class="comment-meta">424					<div class="comment-author vcard">425						<?php426						if ( 0 !== $args['avatar_size'] ) {427							echo get_avatar( $comment, $args['avatar_size'] );428						}429						?>430						<?php431						$comment_author = get_comment_author_link( $comment );432 433						if ( '0' === $comment->comment_approved && ! $show_pending_links ) {434							$comment_author = get_comment_author( $comment );435						}436 437						printf(438							/* translators: %s: Comment author link. */439							__( '%s <span class="says">says:</span>' ),440							sprintf( '<b class="fn">%s</b>', $comment_author )441						);442						?>443					</div><!-- .comment-author -->444 445					<div class="comment-metadata">446						<?php447						printf(448							'<a href="%s"><time datetime="%s">%s</time></a>',449							esc_url( get_comment_link( $comment, $args ) ),450							get_comment_time( 'c' ),451							sprintf(452								/* translators: 1: Comment date, 2: Comment time. */453								__( '%1$s at %2$s' ),454								get_comment_date( '', $comment ),455								get_comment_time()456							)457						);458 459						edit_comment_link( __( 'Edit' ), ' <span class="edit-link">', '</span>' );460						?>461					</div><!-- .comment-metadata -->462 463					<?php if ( '0' === $comment->comment_approved ) : ?>464					<em class="comment-awaiting-moderation"><?php echo $moderation_note; ?></em>465					<?php endif; ?>466				</footer><!-- .comment-meta -->467 468				<div class="comment-content">469					<?php comment_text(); ?>470				</div><!-- .comment-content -->471 472				<?php473				if ( '1' === $comment->comment_approved || $show_pending_links ) {474					comment_reply_link(475						array_merge(476							$args,477							array(478								'add_below' => 'div-comment',479								'depth'     => $depth,480								'max_depth' => $args['max_depth'],481								'before'    => '<div class="reply">',482								'after'     => '</div>',483							)484						)485					);486				}487				?>488			</article><!-- .comment-body -->

Changelog

Introduced in 3.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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/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.