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

Displays the link to the comments for the current post ID.

Contents

Parameters

$zero false|string Optional
String to display when no comments.

Default: false

$one false|string Optional
String to display when only one comment is available.

Default: false

$more false|string Optional
String to display when there are more than one comment.

Default: false

$css_class string Optional
CSS class to use for comments.

Default: ''

$none false|string Optional
String to display when comments have been turned off.

Default: false

Top ↑

Source

File: wp-includes/comment-template.php. View all references 

function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
	$post_id         = get_the_ID();
	$post_title      = get_the_title();
	$comments_number = get_comments_number( $post_id );

	if ( false === $zero ) {
		/* translators: %s: Post title. */
		$zero = sprintf( __( 'No Comments<span class="screen-reader-text"> on %s</span>' ), $post_title );
	}

	if ( false === $one ) {
		/* translators: %s: Post title. */
		$one = sprintf( __( '1 Comment<span class="screen-reader-text"> on %s</span>' ), $post_title );
	}

	if ( false === $more ) {
		/* translators: 1: Number of comments, 2: Post title. */
		$more = _n(
			'%1$s Comment<span class="screen-reader-text"> on %2$s</span>',
			'%1$s Comments<span class="screen-reader-text"> on %2$s</span>',
			$comments_number
		);
		$more = sprintf( $more, number_format_i18n( $comments_number ), $post_title );
	}

	if ( false === $none ) {
		/* translators: %s: Post title. */
		$none = sprintf( __( 'Comments Off<span class="screen-reader-text"> on %s</span>' ), $post_title );
	}

	if ( 0 == $comments_number && ! comments_open() && ! pings_open() ) {
		printf(
			'<span%1$s>%2$s</span>',
			! empty( $css_class ) ? ' class="' . esc_attr( $css_class ) . '"' : '',
			$none
		);
		return;
	}

	if ( post_password_required() ) {
		_e( 'Enter your password to view comments.' );
		return;
	}

	if ( 0 == $comments_number ) {
		$respond_link = get_permalink() . '#respond';
		/**
		 * Filters the respond link when a post has no comments.
		 *
		 * @since 4.4.0
		 *
		 * @param string $respond_link The default response link.
		 * @param int    $post_id      The post ID.
		 */
		$comments_link = apply_filters( 'respond_link', $respond_link, $post_id );
	} else {
		$comments_link = get_comments_link();
	}

	$link_attributes = '';

	/**
	 * Filters the comments link attributes for display.
	 *
	 * @since 2.5.0
	 *
	 * @param string $link_attributes The comments link attributes. Default empty.
	 */
	$link_attributes = apply_filters( 'comments_popup_link_attributes', $link_attributes );

	printf(
		'<a href="%1$s"%2$s%3$s>%4$s</a>',
		esc_url( $comments_link ),
		! empty( $css_class ) ? ' class="' . $css_class . '" ' : '',
		$link_attributes,
		get_comments_number_text( $zero, $one, $more )
	);
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
get_comments_number_text() wp-includes/comment-template.php

Displays the language string for the number of comments the current post has.
_n() wp-includes/l10n.php

Translates and retrieves the singular or plural form based on the supplied number.
post_password_required() wp-includes/post-template.php

Determines whether the post requires password and whether a correct password has been provided.
get_the_ID() wp-includes/post-template.php

Retrieves the ID of the current item in the WordPress Loop.
get_the_title() wp-includes/post-template.php

Retrieves the post title.
comments_open() wp-includes/comment-template.php

Determines whether the current post is open for comments.
pings_open() wp-includes/comment-template.php

Determines whether the current post is open for pings.
get_comments_number() wp-includes/comment-template.php

Retrieves the amount of comments a post has.
get_comments_link() wp-includes/comment-template.php

Retrieves the link to the current post comments.
__() wp-includes/l10n.php

Retrieves the translation of $text.
_e() wp-includes/l10n.php

Displays translated text.
esc_attr() wp-includes/formatting.php

Escaping for HTML attributes.
esc_url() wp-includes/formatting.php

Checks and cleans a URL.
number_format_i18n() wp-includes/functions.php

Converts float number to format based on the locale.
get_permalink() wp-includes/link-template.php

Retrieves the full permalink for the current post or post ID.
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
Show 11 more uses Hide more uses

Top ↑

Changelog

Changelog
Version Description
0.71 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Load Different CSS classes according to Comment-condition
    If you want to load different classes into comments_popup_link(), use the following:

    $css_class = 'zero-comments';
$number    = (int) get_comments_number( get_the_ID() );

if ( 1 === $number )
	$css_class = 'one-comment';
elseif ( 1 < $number )
	$css_class = 'multiple-comments';

comments_popup_link( 
	__( 'Post a Comment', 'wpdocs_textdomain' ), 
	__( '1 Comment', 'wpdocs_textdomain' ), 
	__( '% Comments', 'wpdocs_textdomain' ),
	$css_class,
	__( 'Comments are Closed', 'wpdocs_textdomain' )
);
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by DannyCooper —

    Text Response for Number of Comments with Localization

    Displays the comments popup link, using “No comments yet” for no comments, “1 comment” for one, “% comments” for more than one (% replaced by # of comments), and “Comments are off for this post” if commenting is disabled. Additionally, comments-link is a custom CSS class for the link.

    <?php comments_popup_link( __( 'Leave a comment', 'text-domain' ), __( '1 Comment', 'text-domain' ), __( '% Comments', 'text-domain' ) ); ?>
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Text Response for Number of Comments
    Displays the comments popup link, using “No comments yet” for no comments, “1 comment” for one, “% comments” for more than one (% replaced by # of comments), and “Comments are off for this post” if commenting is disabled. Additionally, comments-link is a custom CSS class for the link.

    <p>
<?php
comments_popup_link( 'No comments yet', '1 comment', '% comments', 'comments-link', 'Comments are off for this post');
?>
</p>
  4. Skip to note 4 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Hide Comment Link When Comments Are Deactivated
    Hides the paragraph element <p></p> that contains the comments_popup_link when comments are deactivated in the Write>Post screen. Good for those who want enable/disable comments post by post. Must be used in the loop.

    <?php
if ( comments_open() ) :
	echo '<p>';
	comments_popup_link( 'No comments yet', '1 comment', '% comments', 'comments-link', 'Comments are off for this post');
	echo '</p>';
endif;
?>

You must log in before being able to contribute a note or feedback.