previous_post_link( string $format = '« %link', string $link = '%title', bool $in_same_term = false, int[]|string $excluded_terms = '', string $taxonomy = 'category' )

Compatibility

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

Parameters

$formatstringoptional

Link anchor format. Default '« %link'.Default: '« %link'

$linkstringoptional

Link permalink format. Default '%title'.Default: '%title'

$in_same_termbooloptional

Whether link should be in the same taxonomy term.
Default false.Default: false

$excluded_termsint[]|stringoptional

Array or comma-separated list of excluded term IDs.
Default empty.Default: ''

$taxonomystringoptional

Taxonomy, if $in_same_term is true. Default 'category'.Default: 'category'

Performance profile

How much work a call to previous_post_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

14

Executed per call on PHP 8.5. The body compiles to 14.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

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

What one call costs · 1 distinct outcome

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

Uses · 1

• get_previous_post_link()Retrieves the previous post link that is adjacent to the current post.

Used by · 2

• twentyfourteen_post_nav()Display navigation to next/previous post when applicable.
• twentythirteen_post_nav()Display navigation to next/previous post when applicable.

Source code

View on Trac ↗View on GitHub ↗

2277function previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {2278	echo get_previous_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy );2279}

Changelog

Introduced in 1.5.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.8.8 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.