get_previous_post() WordPress Function

The get_previous_post() function in WordPress displays the previous post, which is useful for creating a post navigation system on your blog or website. This function is located in wp-includes/link-template.php.

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'


Top ↑

Return

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


Top ↑

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
VersionDescription
1.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More