get_posts_nav_link( string|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

$argsstring|arrayoptional

Arguments to build the post pages link navigation.Default: array()

• $sepstringdefault: '—'

  Separator character.

• $prelabelstringdefault: '« Previous Page'

  Link text to display for the previous page link.

• $nxtlabelstringdefault: 'Next Page »'

  Link text to display for the next page link.

Return value

string

The posts link navigation.

Performance profile

How much work a call to get_posts_nav_link() 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–51

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

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_posts_nav_link()

Further down the call graph this can also reach option, query, cache, serialize 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 · 3 distinct outcomes

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

Uses · 6

• is_singular()Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
• __()Retrieves the translation of $text.
• wp_parse_args()Merges user defined arguments into defaults array.
• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• get_previous_posts_link()Retrieves the previous posts page link.
• get_next_posts_link()Retrieves the next posts page link.

Used by · 1

• posts_nav_link()Displays the post pages link navigation for previous and next pages.

Source code

View on Trac ↗View on GitHub ↗

2726function get_posts_nav_link( $args = array() ) {2727	global $wp_query;2728 2729	$return = '';2730 2731	if ( ! is_singular() ) {2732		$defaults = array(2733			'sep'      => ' &#8212; ',2734			'prelabel' => __( '&laquo; Previous Page' ),2735			'nxtlabel' => __( 'Next Page &raquo;' ),2736		);2737		$args     = wp_parse_args( $args, $defaults );2738 2739		$max_num_pages = $wp_query->max_num_pages;2740		$paged         = get_query_var( 'paged' );2741 2742		// Only have sep if there's both prev and next results.2743		if ( $paged < 2 || $paged >= $max_num_pages ) {2744			$args['sep'] = '';2745		}2746 2747		if ( $max_num_pages > 1 ) {2748			$return  = get_previous_posts_link( $args['prelabel'] );2749			$return .= preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $args['sep'] );2750			$return .= get_next_posts_link( $args['nxtlabel'] );2751		}2752	}2753	return $return;2754}

Changelog

Introduced in 2.8.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 6.9.7 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.