get_next_comments_link() WordPress Function
The get_next_comments_link() function is used to display a link to the next set of comments, if there are any. This is useful for paginating comments.
get_next_comments_link( string $label = '', int $max_page ) #
Retrieves the link to the next comments page.
Parameters
- $label
(string)(Optional) Label for link text.
Default value: ''
- $max_page
(int)(Optional) Max page. Default 0.
Return
(string|void) HTML-formatted link for the next page of comments.
Source
File: wp-includes/link-template.php
function get_next_comments_link( $label = '', $max_page = 0 ) {
global $wp_query;
if ( ! is_singular() ) {
return;
}
$page = get_query_var( 'cpage' );
if ( ! $page ) {
$page = 1;
}
$nextpage = (int) $page + 1;
if ( empty( $max_page ) ) {
$max_page = $wp_query->max_num_comment_pages;
}
if ( empty( $max_page ) ) {
$max_page = get_comment_pages_count();
}
if ( $nextpage > $max_page ) {
return;
}
if ( empty( $label ) ) {
$label = __( 'Newer Comments »' );
}
/**
* Filters the anchor tag attributes for the next comments page link.
*
* @since 2.7.0
*
* @param string $attributes Attributes for the anchor tag.
*/
return '<a href="' . esc_url( get_comments_pagenum_link( $nextpage, $max_page ) ) . '" ' . apply_filters( 'next_comments_link_attributes', '' ) . '>' . preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) . '</a>';
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.7.1 | Introduced. |