TwentyNineteen_Walker_Comment::html5_comment( WP_Comment $comment, int $depth, array $args )
- Source
wp-content/themes/twentynineteen/classes/class-twentynineteen-walker-comment.php:26
Outputs a comment in the HTML5 format.
Compatibility
- WordPress
- core
- 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 TwentyNineteen_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
- Heavy
- Scaling
- Constant
- Instructions
- 146–168
- 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 177.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()one call below TwentyNineteen_Walker_Comment::html5_comment() - optionoption read or write
get_option()one call below TwentyNineteen_Walker_Comment::html5_comment() - querycontent query
get_post()one call below TwentyNineteen_Walker_Comment::html5_comment()
Further down the call graph this can also reach 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost TwentyNineteen_Walker_Comment::html5_comment() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!twentynineteen_is_comment_by_post_author() | 146–157 | comment_ID(), comment_class(), comment_ID(), get_comment_author_url(), get_comment_author(), get_avatar(), twentynineteen_is_comment_by_post_author(), __(), wp_kses(), printf(), __(), get_comment_date(), get_comment_time(), sprintf(), get_comment_link(), esc_url(), get_comment_time(), printf(), twentynineteen_get_icon_svg(), __(), edit_comment_link(), wp_get_current_commenter(), __(), comment_text(), div-comment(), array_merge() |
!empty($comment_author_url) && !twentynineteen_is_comment_by_post_author() | 153–160 | comment_ID(), comment_class(), comment_ID(), get_comment_author_url(), get_comment_author(), get_avatar(), printf(), twentynineteen_is_comment_by_post_author(), __(), wp_kses(), printf(), __(), get_comment_date(), get_comment_time(), sprintf(), get_comment_link(), esc_url(), get_comment_time(), printf(), twentynineteen_get_icon_svg(), __(), edit_comment_link(), wp_get_current_commenter(), __(), comment_text(), div-comment(), array_merge() |
twentynineteen_is_comment_by_post_author() | 154–165 | comment_ID(), comment_class(), comment_ID(), get_comment_author_url(), get_comment_author(), get_avatar(), twentynineteen_is_comment_by_post_author(), twentynineteen_get_icon_svg(), printf(), __(), wp_kses(), printf(), __(), get_comment_date(), get_comment_time(), sprintf(), get_comment_link(), esc_url(), get_comment_time(), printf(), twentynineteen_get_icon_svg(), __(), edit_comment_link(), wp_get_current_commenter(), __(), comment_text(), div-comment(), array_merge() |
!empty($comment_author_url) && twentynineteen_is_comment_by_post_author() | 161–168 | comment_ID(), comment_class(), comment_ID(), get_comment_author_url(), get_comment_author(), get_avatar(), printf(), twentynineteen_is_comment_by_post_author(), twentynineteen_get_icon_svg(), printf(), __(), wp_kses(), printf(), __(), get_comment_date(), get_comment_time(), sprintf(), get_comment_link(), esc_url(), get_comment_time(), printf(), twentynineteen_get_icon_svg(), __(), edit_comment_link(), wp_get_current_commenter(), __(), comment_text(), div-comment(), array_merge() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 179 | 148–170 | 8 | 2 more instructions than PHP 8.5 |
| 8.5 | 177 | 146–168 | 8 | |
| 8.4 | 177 | 146–168 | 8 | |
| 8.3 | 177 | 146–168 | 8 | |
| 8.2 | 177 | 146–168 | 8 | |
| 8.1 | 177 | 146–168 | 8 | |
| 7.4 | 177 | 146–168 | 8 |
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 · 17
- comment_ID()Displays the comment ID of the current comment.
- comment_class()Generates semantic classes for each comment element.
- get_comment_author_url()Retrieves the URL of the author of the current comment, not linked.
- get_comment_author()Retrieves the author of the current comment.
- get_avatar()Retrieves the avatar `` tag for a user, email address, MD5 hash, comment, or post.
- twentynineteen_is_comment_by_post_author()Returns true if comment is by author of the post.
- twentynineteen_get_icon_svg()Gets the SVG code for a given icon.
- wp_kses()Filters text content and strips out disallowed HTML.
- __()Retrieves the translation of $text.
- get_comment_date()Retrieves the comment date of the current comment.
- get_comment_time()Retrieves the comment time of the current comment.
- esc_url()Checks and cleans a URL.
Show all 17
- get_comment_link()Retrieves the link to a given comment.
- edit_comment_link()Displays the edit comment link with formatting.
- wp_get_current_commenter()Gets current commenter's name, email, and URL.
- comment_text()Displays the text of the current comment.
- comment_reply_link()Displays the HTML content for reply to comment link.
Source code
protected function html5_comment( $comment, $depth, $args ) { $tag = ( 'div' === $args['style'] ) ? 'div' : 'li'; ?> <<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class( $this->has_children ? 'parent' : '', $comment ); ?>> <article id="div-comment-<?php comment_ID(); ?>" class="comment-body"> <footer class="comment-meta"> <div class="comment-author vcard"> <?php $comment_author_url = get_comment_author_url( $comment ); $comment_author = get_comment_author( $comment ); $avatar = get_avatar( $comment, $args['avatar_size'] ); if ( 0 !== (int) $args['avatar_size'] ) { if ( empty( $comment_author_url ) ) { echo $avatar; } else { printf( '<a href="%s" rel="external nofollow" class="url">', $comment_author_url ); echo $avatar; } } /* * Using the `check` icon instead of `check_circle`, since we can't add a * fill color to the inner check shape when in circle form. */ if ( twentynineteen_is_comment_by_post_author( $comment ) ) { printf( '<span class="post-author-badge" aria-hidden="true">%s</span>', twentynineteen_get_icon_svg( 'check', 24 ) ); } printf( wp_kses( /* translators: %s: Comment author link. */ __( '%s <span class="screen-reader-text says">says:</span>', 'twentynineteen' ), array( 'span' => array( 'class' => array(), ), ) ), '<b class="fn">' . $comment_author . '</b>' ); if ( ! empty( $comment_author_url ) ) { echo '</a>'; } ?> </div><!-- .comment-author --> <div class="comment-metadata"> <?php /* translators: 1: Comment date, 2: Comment time. */ $comment_timestamp = sprintf( __( '%1$s at %2$s', 'twentynineteen' ), get_comment_date( '', $comment ), get_comment_time() ); printf( '<a href="%s"><time datetime="%s">%s</time></a>', esc_url( get_comment_link( $comment, $args ) ), get_comment_time( 'c' ), $comment_timestamp ); $edit_comment_icon = twentynineteen_get_icon_svg( 'edit', 16 ); edit_comment_link( __( 'Edit', 'twentynineteen' ), ' <span class="edit-link-sep">—</span> <span class="edit-link">' . $edit_comment_icon, '</span>' ); ?> </div><!-- .comment-metadata --> <?php $commenter = wp_get_current_commenter(); if ( $commenter['comment_author_email'] ) { $moderation_note = __( 'Your comment is awaiting moderation.', 'twentynineteen' ); } else { $moderation_note = __( 'Your comment is awaiting moderation. This is a preview; your comment will be visible after it has been approved.', 'twentynineteen' ); } ?> <?php if ( '0' === $comment->comment_approved ) : ?> <p class="comment-awaiting-moderation"><?php echo $moderation_note; ?></p> <?php endif; ?> </footer><!-- .comment-meta -->Changelog
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-content/themes/twentynineteen/classes/class-twentynineteen-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.