get_previous_comments_link() │ WP 2.7.1

Retrieves the link to the previous comments page.

Uses: get_comments_pagenum_link()
Used By: previous_comments_link(), get_the_comments_navigation()
1 time — 0.00019 sec (fast) | 50000 times — 2.7 sec (fast)
Hooks from the function

Returns

String|null. HTML-formatted link for the previous page of comments.

Usage

get_previous_comments_link( $label, $page );
$label(string)
Label for comments link text.
Default: ''
$page(int|null)
Page number.
Default: null

Examples

0

#1 Get a link to the previous comments page the current post

Let's say the post has 44 comments, and we are on the second page of comments, then:

$prev_link = get_previous_comments_link();

/* $link will be equal to
<a href="http://example.com/foo/comment-page-1#comments">← Previous Comments</a>
*/

Changelog

Since 2.7.1 Introduced.
Since 6.7.0 Added the page parameter.

get_previous_comments_link() code WP 6.8.1

wp-includes/link-template.php 
function get_previous_comments_link( $label = '', $page = null ) {
	if ( ! is_singular() ) {
		return;
	}

	if ( is_null( $page ) ) {
		$page = get_query_var( 'cpage' );
	}

	if ( (int) $page <= 1 ) {
		return;
	}

	$previous_page = (int) $page - 1;

	if ( empty( $label ) ) {
		$label = __( '&laquo; Older Comments' );
	}

	/**
	 * Filters the anchor tag attributes for the previous comments page link.
	 *
	 * @since 2.7.0
	 *
	 * @param string $attributes Attributes for the anchor tag.
	 */
	$attr = apply_filters( 'previous_comments_link_attributes', '' );

	return sprintf(
		'<a href="%1$s" %2$s>%3$s</a>',
		esc_url( get_comments_pagenum_link( $previous_page ) ),
		$attr,
		preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $label )
	);
}

Comments pagination (navigation)

Link (tag A in HTML)

Comments