get_the_post_navigation( array $args = array() )

Retrieves the navigation to next/previous post, when applicable.

Parameters

$args

(Optional) Default post navigation arguments. <br>

  • 'prev_text'
    (string) Anchor text to display in the previous post link.<br> Default '%title'.<br>
  • 'next_text'
    (string) Anchor text to display in the next post link.<br> Default '%title'.<br>
  • 'in_same_term'
    (bool) Whether link should be in the same taxonomy term.<br> Default false.<br>
  • 'excluded_terms'
    (int[]|string) Array or comma-separated list of excluded term IDs.<br> <br>
  • 'taxonomy'
    (string) Taxonomy, if $in_same_term is true. Default 'category'.<br>
  • 'screen_reader_text'
    (string) Screen reader text for the nav element.<br> Default 'Post navigation'.<br>
  • 'aria_label'
    (string) ARIA label text for the nav element. Default 'Posts'.<br>
  • 'class'
    (string) Custom class for the nav element. Default 'post-navigation'.<br>

Default value: array()

Return

(string) Markup for post links.

Source

File: wp-includes/link-template.php 

function get_the_post_navigation( $args = array() ) {
	$args = wp_parse_args( $args, array(
		'prev_text'          => '%title',
		'next_text'          => '%title',
		'in_same_term'       => false,
		'excluded_terms'     => '',
		'taxonomy'           => 'category',
		'screen_reader_text' => __( 'Post navigation' ),
	) );

	$navigation = '';

	$previous = get_previous_post_link(
		'<div class="nav-previous">%link</div>',
		$args['prev_text'],
		$args['in_same_term'],
		$args['excluded_terms'],
		$args['taxonomy']
	);

	$next = get_next_post_link(
		'<div class="nav-next">%link</div>',
		$args['next_text'],
		$args['in_same_term'],
		$args['excluded_terms'],
		$args['taxonomy']
	);

	// Only add markup if there's somewhere to navigate to.
	if ( $previous || $next ) {
		$navigation = _navigation_markup( $previous . $next, 'post-navigation', $args['screen_reader_text'] );
	}

	return $navigation;
}

Expand Source Code View on GitHub

Related

Uses

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

Wraps passed links in navigational markup.
wp-includes/link-template.php: get_previous_post_link()

Retrieves the previous post link that is adjacent to the current post.
wp-includes/link-template.php: get_next_post_link()

Retrieves the next post link that is adjacent to the current post.

Used By

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

Displays the navigation to next/previous post, when applicable.

Changelog

Changelog
Version Description
5.5.0 Added the class parameter.
5.3.0 Added the aria_label parameter.
4.4.0 Introduced the in_same_term, excluded_terms, and taxonomy arguments.
4.1.0 Introduced.