get_previous_post( bool $in_same_term = false, int[]|string $excluded_terms = '', string $taxonomy = 'category' )
Retrieves the previous post that is adjacent to the current post.
Parameters
- $in_same_term
-
(Optional) Whether post should be in the same taxonomy term.<br>
Default value: false
- $excluded_terms
-
(Optional) Array or comma-separated list of excluded term IDs.<br>
Default value: ''
- $taxonomy
-
(Optional) Taxonomy, if
$in_same_term
is true. Default 'category'.Default value: 'category'
Return
(WP_Post|null|string) Post object if successful. Null if global $post
is not set.<br> Empty string if no corresponding post exists.
Source
File: wp-includes/link-template.php
function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy );
}
Changelog
Version | Description |
---|---|
1.5.0 | Introduced. |