WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_comments_pagenum_link()

get_comments_pagenum_link( int $pagenum = 1, int $max_page ): string

In this article

Back to top

Retrieves the comments page number link.

Parameters

$pagenumintoptional
Page number.

Default:1

$max_pageintoptional
The maximum number of comment pages. Default 0.

Return

string The comments page number link URL.

Source

function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {	global $wp_rewrite;	$pagenum = (int) $pagenum;	$max_page = (int) $max_page;	$result = get_permalink();	if ( 'newest' === get_option( 'default_comments_page' ) ) {	if ( $pagenum !== $max_page ) {	if ( $wp_rewrite->using_permalinks() ) {	$result = user_trailingslashit( trailingslashit( $result ) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged' );	} else {	$result = add_query_arg( 'cpage', $pagenum, $result );	}	}	} elseif ( $pagenum > 1 ) {	if ( $wp_rewrite->using_permalinks() ) {	$result = user_trailingslashit( trailingslashit( $result ) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged' );	} else {	$result = add_query_arg( 'cpage', $pagenum, $result );	}	}	$result .= '#comments';	/** * Filters the comments page number link for the current request. * * @since 2.7.0 * * @param string $result The comments page number link. */	return apply_filters( 'get_comments_pagenum_link', $result ); }

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_comments_pagenum_link’, string $result )

Filters the comments page number link for the current request.

UsesDescription
user_trailingslashit()wp-includes/link-template.php

Retrieves a trailing-slashed string if the site is set for adding trailing slashes.

WP_Rewrite::using_permalinks()wp-includes/class-wp-rewrite.php

Determines whether permalinks are being used.

trailingslashit()wp-includes/formatting.php

Appends a trailing slash.

add_query_arg()wp-includes/functions.php

Retrieves a modified URL query string.

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.

get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Show 5 moreShow less
Used byDescription
wp_get_canonical_url()wp-includes/link-template.php

Returns the canonical URL for a post.

get_next_comments_link()wp-includes/link-template.php

Retrieves the link to the next comments page.

get_previous_comments_link()wp-includes/link-template.php

Retrieves the link to the previous comments page.

Changelog

VersionDescription
2.7.0Introduced.

User Contributed Notes

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