get_previous_post_link() WordPress Function
The get_previous_post_link() function in WordPress allows you to display a link to the previous post in your blog. This is useful if you want to create a navigation system for your blog that allows readers to move between posts easily.
get_previous_post_link( string $format = '« %link', string $link = '%title', bool $in_same_term = false, int[]|string $excluded_terms = '', string $taxonomy = 'category' ) #
Retrieves the previous post link that is adjacent to the current post.
Parameters
- $format
(string)(Optional) Link anchor format. Default '« %link'.
Default value: '« %link'
- $link
(string)(Optional) Link permalink format.
Default value: '%title'
- $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 term IDs.
Default value: ''
- $taxonomy
(string)(Optional) Taxonomy, if $in_same_term is true.
Default value: 'category'
Return
(string) The link URL of the previous post in relation to the current post.
Source
File: wp-includes/link-template.php
function get_previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
return get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, true, $taxonomy );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.7.0 | Introduced. |