get_posts_nav_link( string|array $args = array() )

Retrieves the post pages link navigation for previous and next pages.

Parameters

$args

(Optional) Arguments to build the post pages link navigation.

  • 'sep'
    (string) Separator character. Default '—'.
  • 'prelabel'
    (string) Link text to display for the previous page link. Default '« Previous Page'.
  • 'nxtlabel'
    (string) Link text to display for the next page link. Default 'Next Page »'.

Default value: array()

Return

(string) The posts link navigation.

Source

File: wp-includes/link-template.php 

function get_posts_nav_link( $args = array() ) {
	global $wp_query;

	$return = '';

	if ( !is_singular() ) {
		$defaults = array(
			'sep' => ' — ',
			'prelabel' => __('« Previous Page'),
			'nxtlabel' => __('Next Page »'),
		);
		$args = wp_parse_args( $args, $defaults );

		$max_num_pages = $wp_query->max_num_pages;
		$paged = get_query_var('paged');

		//only have sep if there's both prev and next results
		if ($paged < 2 || $paged >= $max_num_pages) {
			$args['sep'] = '';
		}

		if ( $max_num_pages > 1 ) {
			$return = get_previous_posts_link($args['prelabel']);
			$return .= preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $args['sep']);
			$return .= get_next_posts_link($args['nxtlabel']);
		}
	}
	return $return;

}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/query.php: is_singular()

Is the query for an existing single post of any post type (post, attachment, page, custom post types)?
wp-includes/query.php: get_query_var()

Retrieve variable in the WP_Query class.
wp-includes/link-template.php: get_previous_posts_link()

Retrieves the previous posts page link.
wp-includes/link-template.php: get_next_posts_link()

Retrieves the next posts page link.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.
Show 1 more use Hide more uses

Used By

Used By
Used By Description
wp-includes/link-template.php: posts_nav_link()

Displays the post pages link navigation for previous and next pages.

Changelog

Changelog
Version Description
WP-2.8.0 Introduced.