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

See also See also


Top ↑

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 ↑

More Information More Information

Used on single post permalink pages, this template tag displays a link to the previous post which exists in chronological order from the current post. This tag must be used in The Loop.

$format is the ormat string for the link. This is where to control what comes before and after the link. '%link' in string will be replaced with whatever is declared as 'link' (see next parameter). 'Go to %link' will generate “Go to <a href=…” Put HTML tags here to style the final results.

$in_same_term indicates whether previous post must be within the same taxonomy term as the current post. If set to 'true', only posts from the current taxonomy term will be displayed. If the post is in both the parent and subcategory, or more than one term, the previous post link will lead to the previous post in any of those terms.
$excluded_terms is an array or a comma-separated list of numeric terms IDs from which the next post should not be listed. For example array(1, 5) or '1,5'. This argument used to accept a list of IDs separated by 'and', this was deprecated in WordPress 3.3.

Top ↑

Source Source

File: wp-includes/link-template.php

function previous_post_link( $format = '&laquo; %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 1 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' ); ?>
    
  2. Skip to note 4 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 ); ?> 
    
  3. Skip to note 5 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' ); ?> 
    
  4. Skip to note 6 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' ); ?>
    

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