get_next_posts_link( string $label = null, int $max_page ): string|void
Retrieves the next posts page link.
Contents
Parameters
-
$label
string Optional -
Content for link text.
Default:
null
-
$max_page
int Optional -
Max pages. Default 0.
Return
string|void HTML-formatted next posts page link.
More Information
Gets a link to the previous set of posts within the current query.
Because post queries are usually sorted in reverse chronological order, get_next_posts_link() usually points to older entries (toward the end of the set) and get_previous_posts_link() usually points to newer entries (toward the beginning of the set).
Source
File: wp-includes/link-template.php
.
View all references
function get_next_posts_link( $label = null, $max_page = 0 ) {
global $paged, $wp_query;
if ( ! $max_page ) {
$max_page = $wp_query->max_num_pages;
}
if ( ! $paged ) {
$paged = 1;
}
$next_page = (int) $paged + 1;
if ( null === $label ) {
$label = __( 'Next Page »' );
}
if ( ! is_single() && ( $next_page <= $max_page ) ) {
/**
* Filters the anchor tag attributes for the next posts page link.
*
* @since 2.7.0
*
* @param string $attributes Attributes for the anchor tag.
*/
$attr = apply_filters( 'next_posts_link_attributes', '' );
return sprintf(
'<a href="%1$s" %2$s>%3$s</a>',
next_posts( $max_page, false ),
$attr,
preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label )
);
}
}
Hooks
-
apply_filters( 'next_posts_link_attributes',
string $attributes ) -
Filters the anchor tag attributes for the next posts page link.
Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Usage when querying the loop with WP_Query
Pass the
$max_page
parameter to theget_next_posts_link()
function when querying the loop withWP_Query
. To get the total amount of pages you can use themax_num_pages
property of the customWP_Query
object.Default Usage
Custom Label
Custom Label and Custom number of post pages