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 ); }
Changelog
Version | Description |
---|---|
2.5.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/adjacent_post_link