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
-
(bool) (Optional) Whether post 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
(null|string|WP_Post) Post object if successful. Null if global $post is not set. 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. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_previous_post