previous_post_link() WordPress Function
The previous_post_link() function displays a link to the previous post, if there is one.
previous_post_link( string $format = '« %link', string $link = '%title', bool $in_same_term = false, int[]|string $excluded_terms = '', string $taxonomy = 'category' ) #
Displays the previous post link that is adjacent to the current post.
Description
See also
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'
More Information
Used on single post permalink pages, this template tag displays a link to the previous post which exists in chronological order from the current post. This tag must be used in The Loop.
$format is the format string for the link. This is where to control what comes before and after the link. '%link' in string will be replaced with whatever is declared as 'link' (see next parameter). 'Go to %link' will generate “Go to <a href=…” Put HTML tags here to style the final results.
- $in_same_term indicates whether previous post must be within the same taxonomy term as the current post. If set to 'true', only posts from the current taxonomy term will be displayed. If the post is in both the parent and subcategory, or more than one term, the previous post link will lead to the previous post in any of those terms.
- $excluded_terms is an array or a comma-separated list of numeric terms IDs from which the next post should not be listed. For example array(1, 5) or '1,5'. This argument used to accept a list of IDs separated by 'and', this was deprecated in WordPress 3.3.
Source
File: wp-includes/link-template.php
function previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
echo get_previous_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 1.5.0 | Introduced. |