comments_popup_link( false|string $zero = false, false|string $one = false, false|string $more = false, string $css_class = '', false|string $none = false )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$zerofalse|stringoptional

String to display when no comments. Default false.Default: false

$onefalse|stringoptional

String to display when only one comment is available. Default false.Default: false

$morefalse|stringoptional

String to display when there are more than one comment. Default false.Default: false

$css_classstringoptional

CSS class to use for comments. Default empty.Default: ''

$nonefalse|stringoptional

String to display when comments have been turned off. Default false.Default: false

Performance profile

How much work a call to comments_popup_link() 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

Reaches the database via get_post().

Scaling

Constant

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

Instructions

32–112

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

Plugin surface

2 hooks

Third-party callbacks on 'respond_link', 'comments_popup_link_attributes' run inside this call, and their cost is not bounded by anything here.

Called by

6

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below comments_popup_link()
• optionoption read or writeget_option()one call below comments_popup_link()

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 · 110 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost comments_popup_link() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while comments_popup_link() runs, in this order:

1. 1
   apply_filters( respond_link )filterline 1698 (+54 into the body)

   Filters the respond link when a post has no comments.

2. 2
   apply_filters( comments_popup_link_attributes )filterline 1712 (+68 into the body)

   Filters the comments link attributes for display.

Uses · 16

• get_the_ID()Retrieves the ID of the current item in the WordPress Loop.
• get_the_title()Retrieves the post title.
• get_comments_number()Retrieves the amount of comments a post has.
• __()Retrieves the translation of $text.
• _n()Translates and retrieves the singular or plural form based on the supplied number.
• number_format_i18n()Converts float number to format based on the locale.
• comments_open()Determines whether the current post is open for comments.
• pings_open()Determines whether the current post is open for pings.
• esc_attr()Escaping for HTML attributes.
• post_password_required()Determines whether the post requires password and whether a correct password has been provided.
• _e()Displays translated text.
• get_permalink()Retrieves the full permalink for the current post or post ID.

Used by · 6

• Twenty_Eleven_Ephemera_Widget::widget()Outputs the HTML for this widget.
• Twenty_Fourteen_Ephemera_Widget::widget()Outputs the HTML for this widget.
• twentyfifteen_entry_meta()Prints HTML with meta information for the categories, tags.
• twentynineteen_comment_count()Prints HTML with the comment count for the current post.
• twentysixteen_entry_meta()Prints HTML with meta information for the categories, tags.
• twentytwenty_get_post_meta()Retrieves the post meta.

Source code

View on Trac ↗View on GitHub ↗

1644function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {1645	$post_id         = get_the_ID();1646	$post_title      = get_the_title();1647	$comments_number = (int) get_comments_number( $post_id );1648 1649	if ( false === $zero ) {1650		/* translators: %s: Post title. */1651		$zero = sprintf( __( 'No Comments<span class="screen-reader-text"> on %s</span>' ), $post_title );1652	}1653 1654	if ( false === $one ) {1655		/* translators: %s: Post title. */1656		$one = sprintf( __( '1 Comment<span class="screen-reader-text"> on %s</span>' ), $post_title );1657	}1658 1659	if ( false === $more ) {1660		/* translators: 1: Number of comments, 2: Post title. */1661		$more = _n(1662			'%1$s Comment<span class="screen-reader-text"> on %2$s</span>',1663			'%1$s Comments<span class="screen-reader-text"> on %2$s</span>',1664			$comments_number1665		);1666		$more = sprintf( $more, number_format_i18n( $comments_number ), $post_title );1667	}1668 1669	if ( false === $none ) {1670		/* translators: %s: Post title. */1671		$none = sprintf( __( 'Comments Off<span class="screen-reader-text"> on %s</span>' ), $post_title );1672	}1673 1674	if ( 0 === $comments_number && ! comments_open() && ! pings_open() ) {1675		printf(1676			'<span%1$s>%2$s</span>',1677			! empty( $css_class ) ? ' class="' . esc_attr( $css_class ) . '"' : '',1678			$none1679		);1680		return;1681	}1682 1683	if ( post_password_required() ) {1684		_e( 'Enter your password to view comments.' );1685		return;1686	}1687 1688	if ( 0 === $comments_number ) {1689		$respond_link = get_permalink() . '#respond';1690		/**1691		 * Filters the respond link when a post has no comments.1692		 *1693		 * @since 4.4.01694		 *1695		 * @param string $respond_link The default response link.1696		 * @param int    $post_id      The post ID.1697		 */1698		$comments_link = apply_filters( 'respond_link', $respond_link, $post_id );1699	} else {1700		$comments_link = get_comments_link();1701	}1702 1703	$link_attributes = '';1704 1705	/**1706	 * Filters the comments link attributes for display.1707	 *1708	 * @since 2.5.01709	 *1710	 * @param string $link_attributes The comments link attributes. Default empty.1711	 */1712	$link_attributes = apply_filters( 'comments_popup_link_attributes', $link_attributes );1713 1714	printf(1715		'<a href="%1$s"%2$s%3$s>%4$s</a>',1716		esc_url( $comments_link ),1717		! empty( $css_class ) ? ' class="' . $css_class . '" ' : '',1718		$link_attributes,1719		get_comments_number_text( $zero, $one, $more )1720	);1721}

Changelog

Introduced in 0.71. 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.9.7 tag, from src/wp-includes/comment-template.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.