WP_List_Table::comments_bubble( int $post_id, int $pending_comments )
- Since
- 3.1.0
- Source
wp-admin/includes/class-wp-list-table.php:843
Displays a comment count bubble.
Compatibility
- WordPress
- since 3.1.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
$post_idint- The post ID.
$pending_commentsint- Number of pending comments.
Performance profile
How much work a call to WP_List_Table::comments_bubble() 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
- 19–116
- 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 168.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- querycontent query
get_post()called directly - hookthird-party callbacks
apply_filters()one call below WP_List_Table::comments_bubble()
Further down the call graph this can also reach option, 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 · 18 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_List_Table::comments_bubble() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!current_user_can() && post_password_required() | 19–20 | get_post(), current_user_can(), post_password_required() |
!current_user_can() && !post_password_required() | 24–25 | get_post(), current_user_can(), post_password_required(), current_user_can() |
current_user_can() | 77–83 | get_post(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), __(), printf(), __(), printf() |
current_user_can() | 81–86 | get_post(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), printf(), __(), printf() |
current_user_can() | 84–89 | get_post(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), __(), printf(), __(), printf() |
current_user_can() | 85–90 | get_post(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), __(), printf(), admin_url(), p(), add_query_arg(), esc_url() |
!post_password_required() | 86–92 | get_post(), current_user_can(), post_password_required(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), __(), printf(), __(), printf() |
current_user_can() | 89–93 | get_post(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), printf(), admin_url(), p(), add_query_arg(), esc_url() |
!post_password_required() | 90–95 | get_post(), current_user_can(), post_password_required(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), printf(), __(), printf() |
current_user_can() | 92–96 | get_post(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), __(), printf(), admin_url(), p(), add_query_arg(), esc_url() |
!post_password_required() | 93–98 | get_post(), current_user_can(), post_password_required(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), __(), printf(), __(), printf() |
!post_password_required() | 94–99 | get_post(), current_user_can(), post_password_required(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), __(), printf(), admin_url(), p(), add_query_arg(), esc_url() |
6 further outcomes, up to 116 instructions
current_user_can() | 95–100 | get_post(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), admin_url(), p(), add_query_arg(), esc_url(), __(), printf() |
!post_password_required() | 98–102 | get_post(), current_user_can(), post_password_required(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), printf(), admin_url(), p(), add_query_arg(), esc_url() |
!post_password_required() | 101–105 | get_post(), current_user_can(), post_password_required(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), __(), printf(), admin_url(), p(), add_query_arg(), esc_url() |
current_user_can() | 103–107 | get_post(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), admin_url(), p(), add_query_arg(), esc_url(), admin_url(), p(), add_query_arg(), esc_url() |
!post_password_required() | 104–109 | get_post(), current_user_can(), post_password_required(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), admin_url(), p(), add_query_arg(), esc_url(), __(), printf() |
!post_password_required() | 112–116 | get_post(), current_user_can(), post_password_required(), current_user_can(), get_comments_number(), number_format_i18n(), number_format_i18n(), _n(), sprintf(), _n(), sprintf(), _n(), sprintf(), get_post_status(), admin_url(), p(), add_query_arg(), esc_url(), admin_url(), p(), add_query_arg(), esc_url() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 171 | 19–120 | 14 | 3 more instructions than PHP 8.5 |
| 8.5 | 168 | 19–116 | 14 | |
| 8.4 | 168 | 19–116 | 14 | |
| 8.3 | 168 | 19–116 | 14 | |
| 8.2 | 168 | 19–116 | 14 | |
| 8.1 | 168 | 19–116 | 14 | |
| 7.4 | 168 | 19–116 | 14 |
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 · 11
- get_post()Retrieves post data given a post ID or post object.
- current_user_can()Returns whether the current user has the specified capability.
- post_password_required()Determines whether the post requires password and whether a correct password has been provided.
- get_comments_number()Retrieves the amount of comments a post has.
- number_format_i18n()Converts float number to format based on the locale.
- _n()Translates and retrieves the singular or plural form based on the supplied number.
- __()Retrieves the translation of $text.
- get_post_status()Retrieves the post status based on the post ID.
- esc_url()Checks and cleans a URL.
- add_query_arg()Retrieves a modified URL query string.
- admin_url()Retrieves the URL to the admin area for the current site.
Source code
protected function comments_bubble( $post_id, $pending_comments ) { $post_object = get_post( $post_id ); $edit_post_cap = $post_object ? 'edit_post' : 'edit_posts'; if ( ! current_user_can( $edit_post_cap, $post_id ) && ( post_password_required( $post_id ) || ! current_user_can( 'read_post', $post_id ) ) ) { // The user has no access to the post and thus cannot see the comments. return false; } $approved_comments = get_comments_number(); $approved_comments_number = number_format_i18n( $approved_comments ); $pending_comments_number = number_format_i18n( $pending_comments ); $approved_only_phrase = sprintf( /* translators: %s: Number of comments. */ _n( '%s comment', '%s comments', $approved_comments ), $approved_comments_number ); $approved_phrase = sprintf( /* translators: %s: Number of comments. */ _n( '%s approved comment', '%s approved comments', $approved_comments ), $approved_comments_number ); $pending_phrase = sprintf( /* translators: %s: Number of comments. */ _n( '%s pending comment', '%s pending comments', $pending_comments ), $pending_comments_number ); if ( ! $approved_comments && ! $pending_comments ) { // No comments at all. printf( '<span aria-hidden="true">—</span>' . '<span class="screen-reader-text">%s</span>', __( 'No comments' ) ); } elseif ( $approved_comments && 'trash' === get_post_status( $post_id ) ) { // Don't link the comment bubble for a trashed post. printf( '<span class="post-com-count post-com-count-approved">' . '<span class="comment-count-approved" aria-hidden="true">%s</span>' . '<span class="screen-reader-text">%s</span>' . '</span>', $approved_comments_number, $pending_comments ? $approved_phrase : $approved_only_phrase ); } elseif ( $approved_comments ) { // Link the comment bubble to approved comments. printf( '<a href="%s" class="post-com-count post-com-count-approved">' . '<span class="comment-count-approved" aria-hidden="true">%s</span>' . '<span class="screen-reader-text">%s</span>' . '</a>', esc_url( add_query_arg( array( 'p' => $post_id, 'comment_status' => 'approved', ), admin_url( 'edit-comments.php' ) ) ), $approved_comments_number, $pending_comments ? $approved_phrase : $approved_only_phrase ); } else { // Don't link the comment bubble when there are no approved comments. printf( '<span class="post-com-count post-com-count-no-comments">' . '<span class="comment-count comment-count-no-comments" aria-hidden="true">%s</span>' . '<span class="screen-reader-text">%s</span>' . '</span>', $approved_comments_number, $pending_comments ?Changelog
Introduced in 3.1.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-admin/includes/class-wp-list-table.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.