get_previous_comments_link( string $label = '' )

Retrieves the link to the previous comments page.

Parameters

$label

(Optional) Label for comments link text.

Default value: ''

Return

(string|void) HTML-formatted link for the previous page of comments.

Source

File: wp-includes/link-template.php 

function get_previous_comments_link( $label = '' ) {
	if ( ! is_singular() )
		return;

	$page = get_query_var('cpage');

	if ( intval($page) <= 1 )
		return;

	$prevpage = intval($page) - 1;

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

	/**
	 * Filters the anchor tag attributes for the previous comments page link.
	 *
	 * @since WP-2.7.0
	 *
	 * @param string $attributes Attributes for the anchor tag.
	 */
	return '<a href="' . esc_url( get_comments_pagenum_link( $prevpage ) ) . '" ' . apply_filters( 'previous_comments_link_attributes', '' ) . '>' . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $label) .'</a>';
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/query.php: is_singular()

Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
wp-includes/query.php: get_query_var()

Retrieves the value of a query variable in the WP_Query class.
wp-includes/link-template.php: get_comments_pagenum_link()

Retrieves the comments page number link.
wp-includes/link-template.php: previous_comments_link_attributes

Filters the anchor tag attributes for the previous comments page link.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Used By

Used By
Used By Description
wp-includes/link-template.php: previous_comments_link()

Displays the link to the previous comments page.
wp-includes/link-template.php: get_the_comments_navigation()

Retrieves navigation to next/previous set of comments, when applicable.

Changelog

Changelog
Version Description
2.7.1 Introduced.