wppaste
WordPress

adjacent_posts_rel_link( string $title = '%title', bool $in_same_term = false, int[]|string $excluded_terms = '', string $taxonomy = 'category' )

Since
2.8.0
Source
wp-includes/link-template.php:2117
Displays the relational links for the posts adjacent to the current post.

Compatibility

WordPress
since 2.8.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$titlestringoptional
Link title 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 adjacent_posts_rel_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
Heavy

Reaches the database via get_post().

Scaling
Constant

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

Instructions
21

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

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

  • querycontent queryget_post()one call below adjacent_posts_rel_link()
  • optionoption read or writeget_option()one call below adjacent_posts_rel_link()
  • hookthird-party callbacksapply_filters()one call below adjacent_posts_rel_link()

Further down the call graph this can also reach 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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always21get_adjacent_post_rel_link(), get_adjacent_post_rel_link()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 21 instructions, 21 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

Used by · 1

Source code

View on Trac View on GitHub 

function adjacent_posts_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {	echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy );	echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy );}

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.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.