W3cubDocs

/WordPress

get_the_posts_navigation( array $args = array() )

Returns the navigation to next/previous set of posts, when applicable.

Description

Parameters

$args

(array) (Optional) Default posts navigation arguments.

  • 'prev_text'
    (string) Anchor text to display in the previous posts link. Default 'Older posts'.
  • 'next_text'
    (string) Anchor text to display in the next posts link. Default 'Newer posts'.
  • 'screen_reader_text'
    (string) Screen reader text for nav element. Default 'Posts navigation'.

Default value: array()

Return

(string) Markup for posts links.

Source

File: wp-includes/link-template.php

function get_the_posts_navigation( $args = array() ) {
	$navigation = '';

	// Don't print empty markup if there's only one page.
	if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
		$args = wp_parse_args(
			$args,
			array(
				'prev_text'          => __( 'Older posts' ),
				'next_text'          => __( 'Newer posts' ),
				'screen_reader_text' => __( 'Posts navigation' ),
			)
		);

		$next_link = get_previous_posts_link( $args['next_text'] );
		$prev_link = get_next_posts_link( $args['prev_text'] );

		if ( $prev_link ) {
			$navigation .= '<div class="nav-previous">' . $prev_link . '</div>';
		}

		if ( $next_link ) {
			$navigation .= '<div class="nav-next">' . $next_link . '</div>';
		}

		$navigation = _navigation_markup( $navigation, 'posts-navigation', $args['screen_reader_text'] );
	}

	return $navigation;
}

Changelog

Version Description
4.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_the_posts_navigation