WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_previous_post_link()

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

In this article

Back to top

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

Parameters

$formatstringoptional
Link anchor format. Default ‘« %link’.

Default:'« %link'

$linkstringoptional
Link permalink format. Default '%title'.

Default:'%title'

$in_same_termbooloptional
Whether link should be in the same taxonomy term.

Default:false

$excluded_termsint[]|stringoptional
Array or comma-separated list of excluded term IDs.

Default:''

$taxonomystringoptional
Taxonomy, if $in_same_term is true. Default 'category'.

Default:'category'

Return

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

Source

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

View all references View on Trac View on GitHub

UsesDescription
get_adjacent_post_link()wp-includes/link-template.php

Retrieves the adjacent post link.

Used byDescription
get_the_post_navigation()wp-includes/link-template.php

Retrieves the navigation to next/previous post, when applicable.

previous_post_link()wp-includes/link-template.php

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

Changelog

VersionDescription
3.7.0Introduced.

User Contributed Notes

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