Categories

Loop Post Navigation Links

Author: Scott Reilly
Version: 3.0.1
First released: 2009-07-23
Last update: 2020-05-11
Compatibility: WP 4.9 – 5.4.1
Download: [ zip ]
Description:

Template tags (for use in single.php) to create post navigation loop (previous to first post…

Extended Description

This plugin provides two template tags for use in single.php to create a post navigation loop, whereby previous to the first post is the last post, and after the last post is first post. Basically, when you’re on the last post and you click to go to the next post, the link takes you to the first post. Likewise, if you’re on the first post and click to go to the previous post, the link takes you to the last post.

The function c2c_next_or_loop_post_link() is identical to WordPress’s next_post_link() in every way except when called on the last post in the navigation sequence, in which case it links back to the first post in the navigation sequence.

The function c2c_previous_or_loop_post_link() is identical to WordPress’s previous_post_link() in every way except when called on the first post in the navigation sequence, in which case it links back to the last post in the navigation sequence.

Useful for providing a looping link of posts, such as for a portfolio, or to continually present pertinent posts for visitors to continue reading.

If you are interested in getting the post itself and not just a link to the post, you can use the c2c_get_next_or_loop_post() and c2c_get_previous_or_loop_post() functions. If you just want the URL to the post, you can use c2c_get_next_or_loop_post_url() and c2c_get_previous_or_loop_post_url().

Links: Plugin Homepage | Plugin Directory Page | GitHub | Author Homepage

Template Tags

The plugin provides four template tags for use in your single-post theme templates.

Functions

  • function c2c_next_or_loop_post_link( $format='%link »', $link='%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
    Like WordPress’s next_post_link(), this function displays a link to the next chronological post (among all published posts, those in the same category, or those not in certain categories). Unlink next_post_link(), when on the last post in the sequence this function will link back to the first post in the sequence, creating a circular loop.

  • function c2c_get_next_or_loop_post_link( $format='%link »', $link='%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
    Like `c2c_next_or_loop_post_link(), but returns the value without echoing it.

  • function c2c_previous_or_loop_post_link( $format='« %link', $link='%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
    Like WordPress’s previous_post_link(), this function displays a link to the previous chronological post (among all published posts, those in the same category, or those not in certain categories). Unlink previous_post_link(), when on the first post in the sequence this function will link to the last post in the sequence, creating a circular loop.

  • function c2c_get_previous_or_loop_post_link( $format='« %link', $link='%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
    Like `c2c_get_previous_or_loop_post_link(), but returns the value without echoing it.

  • function c2c_get_next_or_loop_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
    Like WordPress’s get_adjacent_post() when used to find the next post, except when on the last post in the sequence this function will return the first post in the sequence, creating a circular loop.

  • function c2c_get_previous_or_loop_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
    Like WordPress’s get_adjacent_post() when used to find the previous post, except when on the first post in the sequence this function will return the last post in the sequence, creating a circular loop.

  • function c2c_get_next_or_loop_post_url( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
    Returns the URL for the next post or the post at the beginning of the series.

  • function c2c_get_previous_or_loop_post_url( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
    Returns the URL for the previous post or the post at the end of the series.

Arguments

  • $format
    (optional) A percent-substitution string indicating the format of the entire output string. Use %link to represent the next/previous post being linked, or %title to represent the title of the next/previous post.

  • $link
    (optional) A percent-substitution string indicating the format of the link itself that gets created for the next/previous post. Use %link to represent the next/previous post being linked, or %title to represent the title of the next/previous post.

  • $in_same_term
    (optional) A boolean value (either true or false) indicating if the next/previous post should be in the current post’s same taxonomy term.

  • $excluded_terms
    (optional) An array or comma-separated string of category or term IDs to which posts cannot belong.

  • $taxonomy
    (optional) Taxonomy, if $in_same_term is true. Default ‘category’.

Examples

<div class="loop-navigation">
    <div class="alignleft"><?php c2c_previous_or_loop_post_link(); ?></div>
    <div class="alignright"><?php c2c_next_or_loop_post_link(); ?></div>
</div><h3>Hooks</h3>

The plugin is further customizable via eleven hooks. Typically, code making use of hooks should ideally be put into a mu-plugin, a site-specific plugin (which is beyond the scope of this readme to explain), or in theme template files. Many of these filters are likely only of interest to advanced users able to code.

c2c_previous_or_loop_post_link_output, c2c_next_or_loop_post_link_output (filters)

The ‘c2c_previous_or_loop_post_link_output’ and ‘c2c_next_or_loop_post_link_output’ filters allow you to customize the link markup generated for previous and next looping links, respectively.

Arguments:

  • $format (string): Link anchor format.
  • $link (string): Link permalink format.
  • $in_same_term (bool): Optional. Whether link should be in a same taxonomy term. Default is false.
  • $excluded_terms (array|string): Optional. Array or comma-separated list of excluded term IDs. Default is ”.
  • $previous (bool): Optional. Whether to display link to previous or next post. Default is true.
  • $taxonomy (string): Optional. Taxonomy, if $in_same_term is true. Default ‘category’.
  • $adjacent (string): Whether the post is previous or next.

Example:

  <?php
      // Prepend "Prev:" to previous link markup.
      function my_custom_previous_or_loop_link_output( $output, $format, $link, $post, $in_same_term, $excluded_terms, $taxonomy ) {
        return 'Prev: ' . $output;
      }
      add_filter( 'c2c_previous_or_loop_post_link_output', 'my_custom_previous_or_loop_link_output', 10, 4 );
    ?>

c2c_previous_or_loop_post_link_get, c2c_next_or_loop_post_link_get (filters)

The ‘c2c_previous_or_loop_post_link_get’ and ‘c2c_next_or_loop_post_link_get’ filters allow you to customize the link markups generated for previous and next looping links, respectively, but in the non-echoing functions.

Arguments:

  • $output (string): The adjacent post link.
  • $format (string): Link anchor format.
  • $link (string): Link permalink format.
  • $post (WP_Post): The adjacent post.
  • $in_same_term (bool): Optional. Whether link should be in a same taxonomy term. Default is false.
  • $excluded_terms (array|string): Optional. Array or comma-separated list of excluded term IDs. Default is ”.
  • $previous (bool): Optional. Whether to display link to previous or next post. Default is true.
  • $taxonomy (string): Optional. Taxonomy, if $in_same_term is true. Default ‘category’.
  • $adjacent (string): Whether the post is previous or next.

c2c_previous_or_loop_post_link, c2c_next_or_loop_post_link, c2c_get_previous_or_loop_post_link, c2c_get_next_or_loop_post_link, c2c_get_adjacent_or_loop_post, c2c_get_previous_or_loop_post, c2c_get_previous_or_loop_post (actions)

The ‘c2c_previous_or_loop_post_link’ and ‘c2c_next_or_loop_post_link’ actions allow you to use an alternative approach to safely invoke c2c_previous_or_loop_post_link() and c2c_next_or_loop_post_link(), respectively, in such a way that if the plugin were deactivated or deleted, then your calls to the functions won’t cause errors in your site. The ‘c2c_get_previous_or_loop_post_link’ and ‘c2c_get_next_or_loop_post_link’ filters do the same for the non-echoing c2c_previous_or_loop_post_link() and c2c_next_or_loop_post_link().

Arguments:

  • Same as for for c2c_previous_or_loop_post_link() and c2c_next_or_loop_post_link()

Example:

Instead of:

<?php c2c_previous_or_loop_post_link( '<span class="prev-or-loop-link">&laquo; %link</span>' ); ?>

Do:

<?php do_action( 'c2c_previous_or_loop_post_link', '<span class="prev-or-loop-link">&laquo; %link</span>' ); ?>

Find out more at the plugin’s WordPress Plugin Repository page.

Installation

  1. Install via the built-in WordPress plugin installer. Or install the plugin code inside the plugins directory for your site (typically wp-content/plugins/).
  2. Activate the plugin through the ‘Plugins’ admin menu in WordPress.
  3. Use c2c_next_or_loop_post_link() template tag instead of next_post_link(), and/or c2c_previous_or_loop_post_link() template tag instead of previous_post_link(), in your single-post template (e.g. single.php).

Release Log

3.0.1 (2020-05-10)

  • Change: Use HTTPS for link to WP SVN repository in bin script for configuring unit tests
  • Change: Note compatibility through WP 5.4+
  • Change: Update links to coffee2code.com to be HTTPS

3.0 (2020-01-28)

  • Significant update after a long hiatus! Adds functions for getting the URL of the previous/next post, modernizes unit tests, adds CHANGELOG.md, adds plugin to GitHub, changes plugin initialization, updates compatibility to be for WP 4.9-5.3+, and many other documentation and behind-the-scenes changes.
  • Note that there is an incompatible fix for missing and incorrect arguments for the c2c_{$adjacent}_or_loop_post_link_output filter. This change won’t affect you unless you have custom code making use of the filter, which is unlikely for almost all users.

Details:

  • New: Add c2c_get_next_or_loop_post_url() and c2c_get_previous_or_loop_post_url() to get URL of adjacent/looped post
  • New: Add CHANGELOG.md file and move all but most recent changelog entries into it
  • New: Add README.md file
  • New: Add TODO.md and move existing TODO list from top of main plugin file into it (and add more items to the list)
  • New: Add inline documentation for hooks
  • New: Add GitHub link to readme.txt
  • Fix: Add missing argument $previous and remove argument $post from c2c_{$adjacent}_or_loop_post_link_output hook invocation
  • Change: Add $adjacent argument to a number of filters, to sync with WP core
    • Adds to {$adjacent}_post_link, {$adjacent}_or_loop_post_link, c2c_{$adjacent}_or_loop_post_link_get, and c2c_{$adjacent}_or_loop_post_link_output
  • Change: Use c2c_get_adjacent_or_loop_post() to obtain post, rather than duplicating its functionality in c2c_get_adjacent_or_loop_post_link()
  • Change: Remove unnecessary (and incorrect) determination of adjacent post in c2c_adjacent_or_loop_post_link()
  • Change: Use a different variable name to avoid changing variable sent as function argument and later passed as argument to filter
  • Change: Initialize plugin on ‘plugins_loaded’ action instead of on load
  • Change: Use apply_filters_deprecated() to formally deprecate the {$adjacent}_or_loop_post_link filter
  • Change: Update code formatting to match modern WordPress standards
  • Change: Remove load_textdomain() and just load the textdomain within init()
  • Unit tests:
    • Change: Change expected() to optionally not include arrow quotes
    • Change: Update unit test install script and bootstrap to use latest WP unit test repo
    • Change: Enable more error output for unit tests
    • Change: Comment out unit tests that weren’t actually testing anything
    • Fix: Don’t declare $posts as being static since it’s never referenced as if it was
    • New: Add tests for hooks
  • Change: Note compatibility through WP 5.3+
  • Change: Drop compatibility with versions of WP older than 4.9
  • Change: Include documentation on filter arguments
  • Change: Tweak formatting for installation instructions
  • Change: Remove documentation for non-existent parameters of modify_nextprevious_post_where()
  • Change: Remove unnecessary echo in code example
  • Change: Modify formatting of hook name in readme to prevent being uppercased when shown in the Plugin Directory
  • Change: Rename readme.txt section from ‘Filters’ to ‘Hooks’ and provide a better section intro
  • Change: Update License URI to be HTTPS
  • Change: Update copyright date (2020)
  • Change: Update installation instruction to prefer built-in installer over .zip file

2.6.1 (2016-03-10)

  • New: Add support for language packs:
    • Define ‘Text Domain’ header attribute.
    • Load textdomain.
  • New: Add LICENSE file.
  • New: Create empty index.php to prevent files from being listed if web server has enabled directory listings.
  • Change: Note compatibility through WP 4.4+.
  • Change: Explicitly declare methods in unit tests as public.
  • Change: Update copyright date (2016).

Copyright & Disclaimer

Copyright © 2009-2020 by Scott Reilly (aka coffee2code)

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Discussion / Support

Have any questions, comments, or suggestions? Please provide them via the plugin’s WordPress.org support forum. I’ll do my best to reply in a timely fashion and help as best I can.

Unfortunately, I cannot provide guaranteed support, nor do I provide support via any other means.

Was this plugin useful useful to you? Consider giving it a rating. If you’re inclined to give it a poor rating, please first post to the support forum to give me a chance to address or explain the situation.

2 replies on “Loop Post Navigation Links”

Leave a Reply

Your email address will not be published.