WP_List_Table::comments_bubble( int $post_id, int $pending_comments )

Parameters

$post_idint

The post ID.

$pending_commentsint

Number of pending comments.

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

View on Trac ↗View on GitHub ↗

836	protected function comments_bubble( $post_id, $pending_comments ) {837		$post_object   = get_post( $post_id );838		$edit_post_cap = $post_object ? 'edit_post' : 'edit_posts';839 840		if ( ! current_user_can( $edit_post_cap, $post_id )841			&& ( post_password_required( $post_id )842				|| ! current_user_can( 'read_post', $post_id ) )843		) {844			// The user has no access to the post and thus cannot see the comments.845			return false;846		}847 848		$approved_comments = get_comments_number();849 850		$approved_comments_number = number_format_i18n( $approved_comments );851		$pending_comments_number  = number_format_i18n( $pending_comments );852 853		$approved_only_phrase = sprintf(854			/* translators: %s: Number of comments. */855			_n( '%s comment', '%s comments', $approved_comments ),856			$approved_comments_number857		);858 859		$approved_phrase = sprintf(860			/* translators: %s: Number of comments. */861			_n( '%s approved comment', '%s approved comments', $approved_comments ),862			$approved_comments_number863		);864 865		$pending_phrase = sprintf(866			/* translators: %s: Number of comments. */867			_n( '%s pending comment', '%s pending comments', $pending_comments ),868			$pending_comments_number869		);870 871		if ( ! $approved_comments && ! $pending_comments ) {872			// No comments at all.873			printf(874				'<span aria-hidden="true">&#8212;</span>' .875				'<span class="screen-reader-text">%s</span>',876				__( 'No comments' )877			);878		} elseif ( $approved_comments && 'trash' === get_post_status( $post_id ) ) {879			// Don't link the comment bubble for a trashed post.880			printf(881				'<span class="post-com-count post-com-count-approved">' .882					'<span class="comment-count-approved" aria-hidden="true">%s</span>' .883					'<span class="screen-reader-text">%s</span>' .884				'</span>',885				$approved_comments_number,886				$pending_comments ? $approved_phrase : $approved_only_phrase887			);888		} elseif ( $approved_comments ) {889			// Link the comment bubble to approved comments.890			printf(891				'<a href="%s" class="post-com-count post-com-count-approved">' .892					'<span class="comment-count-approved" aria-hidden="true">%s</span>' .893					'<span class="screen-reader-text">%s</span>' .894				'</a>',895				esc_url(896					add_query_arg(897						array(898							'p'              => $post_id,899							'comment_status' => 'approved',900						),901						admin_url( 'edit-comments.php' )902					)903				),904				$approved_comments_number,905				$pending_comments ? $approved_phrase : $approved_only_phrase906			);907		} else {908			// Don't link the comment bubble when there are no approved comments.909			printf(910				'<span class="post-com-count post-com-count-no-comments">' .911					'<span class="comment-count comment-count-no-comments" aria-hidden="true">%s</span>' .912					'<span class="screen-reader-text">%s</span>' .913				'</span>',914				$approved_comments_number,915				$pending_comments ?

History

Introduced in 3.1.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 6.7.7 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.