W3cubDocs

/WordPress

get_previous_post_link( string $format = '« %link', string $link = '%title', bool $in_same_term = false, array|string $excluded_terms = '', string $taxonomy = 'category' )

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

Description

Parameters

$format

(string) (Optional) Link anchor format. Default '« %link'.

Default value: '« %link'

$link

(string) (Optional) Link permalink format.

Default value: '%title'

$in_same_term

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

Default value: false

$excluded_terms

(array|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

(string) The link URL of the previous post in relation to the current post.

Source

File: wp-includes/link-template.php

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.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_previous_post_link