get_the_posts_navigation( array $args = array() ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarrayoptional

Default posts navigation arguments. Default empty array.Default: array()

• $prev_textstringdefault: 'Older posts'

  Anchor text to display in the previous posts link.

• $next_textstringdefault: 'Newer posts'

  Anchor text to display in the next posts link.

• $screen_reader_textstringdefault: 'Posts navigation'

  Screen reader text for the nav element.

• $aria_labelstringdefault: 'Posts'

  ARIA label text for the nav element.

• $classstringdefault: 'posts-navigation'

  Custom class for the nav element.

Return value

string

Markup for posts links.

Performance profile

How much work a call to get_the_posts_navigation() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

7–69

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 69.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below get_the_posts_navigation()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_the_posts_navigation() can have, taken from its control-flow graph on PHP 8.5.

Uses · 5

• wp_parse_args()Merges user defined arguments into defaults array.
• __()Retrieves the translation of $text.
• get_previous_posts_link()Retrieves the previous posts page link.
• get_next_posts_link()Retrieves the next posts page link.
• _navigation_markup()Wraps passed links in navigational markup.

Used by · 1

• the_posts_navigation()Displays the navigation to next/previous set of posts, when applicable.

Source code

View on Trac ↗View on GitHub ↗

2878function get_the_posts_navigation( $args = array() ) {2879	global $wp_query;2880 2881	$navigation = '';2882 2883	// Don't print empty markup if there's only one page.2884	if ( $wp_query->max_num_pages > 1 ) {2885		// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.2886		if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {2887			$args['aria_label'] = $args['screen_reader_text'];2888		}2889 2890		$args = wp_parse_args(2891			$args,2892			array(2893				'prev_text'          => __( 'Older posts' ),2894				'next_text'          => __( 'Newer posts' ),2895				'screen_reader_text' => __( 'Posts navigation' ),2896				'aria_label'         => __( 'Posts' ),2897				'class'              => 'posts-navigation',2898			)2899		);2900 2901		$next_link = get_previous_posts_link( $args['next_text'] );2902		$prev_link = get_next_posts_link( $args['prev_text'] );2903 2904		if ( $prev_link ) {2905			$navigation .= '<div class="nav-previous">' . $prev_link . '</div>';2906		}2907 2908		if ( $next_link ) {2909			$navigation .= '<div class="nav-next">' . $next_link . '</div>';2910		}2911 2912		$navigation = _navigation_markup( $navigation, $args['class'], $args['screen_reader_text'], $args['aria_label'] );2913	}2914 2915	return $navigation;2916}

Changelog

Introduced in 4.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.