get_previous_post( bool $in_same_term = false, array|string $excluded_terms = '', string $taxonomy = 'category' )

Retrieves the previous post that is adjacent to the current post.

Description Description

Parameters Parameters


(bool) (Optional) Whether post should be in a same taxonomy term.

Default value: false


(array|string) (Optional) Array or comma-separated list of excluded term IDs.

Default value: ''


(string) (Optional) Taxonomy, if $in_same_term is true.

Default value: 'category'

Top ↑

Return Return

(null|string|WP_Post) Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.

Top ↑

Source 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 );

Top ↑

Changelog Changelog

Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.