get_previous_comments_link( string $label = '' ): string|void
Retrieves the link to the previous comments page.
Parameters
-
$label
string Optional -
Label for comments link text.
Default:
''
Return
string|void HTML-formatted link for the previous page of comments.
Source
File: wp-includes/link-template.php
.
View all references
function get_previous_comments_link( $label = '' ) {
if ( ! is_singular() ) {
return;
}
$page = get_query_var( 'cpage' );
if ( (int) $page <= 1 ) {
return;
}
$previous_page = (int) $page - 1;
if ( empty( $label ) ) {
$label = __( '« 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', '&$1', $label )
);
}
Hooks
-
apply_filters( 'previous_comments_link_attributes',
string $attributes ) -
Filters the anchor tag attributes for the previous comments page link.
Changelog
Version | Description |
---|---|
2.7.1 | Introduced. |