get_posts_nav_link() WP 1.0

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

No Hooks.

Return

String. The posts link navigation.

Usage

get_posts_nav_link( $args );

$args(string/array)

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: array()

Notes

• Global. WP_Query. $wp_query WordPress Query object.

Changelog

Code of get posts nav link: wp-includes/link-template.php ^{WP 5.4.2}

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

	$return = '';

	if ( ! is_singular() ) {
		$defaults = array(
			'sep'      => ' &#8212; ',
			'prelabel' => __( '&laquo; Previous Page' ),
			'nxtlabel' => __( 'Next Page &raquo;' ),
		);
		$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;

}

Related Functions

From tag: Navigation pagination

More from category: Archives