adjacent_post_link() WordPress Function
The adjacent_post_link() function is used to display a link to the adjacent post, based on the current post's publish date.
adjacent_post_link( string $format, string $link, bool $in_same_term = false, int[]|string $excluded_terms = '', bool $previous = true, string $taxonomy = 'category' ) #
Displays the adjacent post link.
Description
Can be either next post link or previous.
Parameters
- $format
(string)(Required)Link anchor format.
- $link
(string)(Required)Link permalink format.
- $in_same_term
(bool)(Optional) Whether link should be in a same taxonomy term.
Default value: false
- $excluded_terms
(int[]|string)(Optional) Array or comma-separated list of excluded category IDs.
Default value: ''
- $previous
(bool)(Optional) Whether to display link to previous or next post.
Default value: true
- $taxonomy
(string)(Optional) Taxonomy, if $in_same_term is true.
Default value: 'category'
Source
File: wp-includes/link-template.php
function adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
echo get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, $previous, $taxonomy );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |