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.

Top ↑

Return

string|void HTML-formatted next posts page link.

Top ↑

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).

Top ↑

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', '&#038;$1', $label )
		);
	}
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
next_posts() wp-includes/link-template.php

Displays or retrieves the next posts page link.
is_single() wp-includes/query.php

Determines whether the query is for an existing single post.
__() wp-includes/l10n.php

Retrieves the translation of $text.
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
Show 2 more uses Hide more uses

Top ↑

Changelog

Changelog
Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Usage when querying the loop with WP_Query

    Pass the $max_page parameter to the get_next_posts_link() function when querying the loop with WP_Query. To get the total amount of pages you can use the max_num_pages property of the custom WP_Query object.

    <?php
/**
 * Set the "paged" parameter (use 'page' if the query is on a static front page).
 *
 * @var int $paged
 */
$paged = get_query_var( 'paged' ) ? intval( get_query_var( 'paged' ) ) : 1;

/** @var WP_Query $the_query */
$the_query = new WP_Query( 'cat=1&paged=' . $paged );

if ( $the_query->have_posts() ) :

	// The Loop
	while ( $the_query->have_posts() ) : $the_query->the_post();
		the_title();
	endwhile;

	// get_next_posts_link() usage with max_num_pages.
	echo get_next_posts_link( __( 'Older Entries', 'textdomain' ), $the_query->max_num_pages );
	echo get_previous_posts_link( __( 'Newer Entries', 'textdomain' ) );

	// Clean up after our custom query.
	wp_reset_postdata();

else :
	?>
	<p><?php _e( 'Sorry, no posts matched your criteria.', 'textdomain' ); ?></p>
<?php endif; ?>

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