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

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


Description Description


Parameters 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'


Top ↑

Source Source

File: wp-includes/link-template.php

function previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
	echo get_previous_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy );
}

Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note content
    Contributed by Codex

    Text As Link, Without Post Title, Within Same Category

    Displays custom text as link to the previous post within the same category as the current post. Post title is not included here. “Previous in category” is the custom text, which can be changed to fit your requirements.

    Previous in category

    <?php previous_post_link( '%link', __( 'Previous in category', 'textdomain' ), true ); ?> 
    
  2. Skip to note content
    Contributed by Codex

    Within Same Category, Excluding One

    Displays link to previous post in the same category, as long as it is not in category 13 (the category ID #). You can change the number to any category you wish to exclude. Array or comma-separated list of category ID(s) from which the previous post should not be listed. For example array( 1, 5) or ‘1,5’.

    Previous in category

    <?php previous_post_link( '%link', 'Previous in category', true, '13' ); ?> 
    
  3. Skip to note content
    Contributed by Codex

    Within Same Taxonomy

    Displays link to previous post in the same taxonomy term. Post Formats are a taxonomy so the following would link to the previous post with the same post format.

    Previous post in taxonomy

    <?php previous_post_link( '%link', 'Previous post in category', true, ' ', 'post_format' ); ?>
    
  4. Skip to note content
    Contributed by Codex

    Post Title As Link, Within Same Custom Taxonomy

    Displays link to previous post in the same custom taxonomy term. You have a Custom Post Type called Buildings, and a custom taxonomy called Neighborhood

    Previous Title in Neighborhood

    <?php previous_post_link( '%link', '%title', true, ' ', 'neighborhood' ); ?>
    

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