get_previous_post_link( string $format = '« %link', string $link = '%title', bool $in_same_term = false, int[]|string $excluded_terms = '', string $taxonomy = 'category' ): string
Retrieves the previous post link that is adjacent to the current post.
Parameters
-
$formatstring Optional -
Link anchor format. Default '« %link'.
Default:
'« %link' -
$linkstring Optional -
Link permalink format. Default
'%title'.Default:
'%title' -
$in_same_termbool Optional -
Whether link should be in the same taxonomy term.
Default:
false -
$excluded_termsint[]|string Optional -
Array or comma-separated list of excluded term IDs.
Default:
'' -
$taxonomystring Optional -
Taxonomy, if
$in_same_termis true. Default'category'.Default:
'category'
Return
string The link URL of the previous post in relation to the current post.
Source
File: wp-includes/link-template.php.
View all references
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 );
}
Changelog
| Version | Description |
|---|---|
| 3.7.0 | Introduced. |