Scott Reilly

<p>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.</p>
<p>The function <code>c2c_next_or_loop_post_link()</code> is identical to WordPress’s <code>next_post_link()</code> 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.</p>
<p>The function <code>c2c_previous_or_loop_post_link()</code> is identical to WordPress’s <code>previous_post_link()</code> 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.</p>
<p>Useful for providing a looping link of posts, such as for a portfolio, or to continually present pertinent posts for visitors to continue reading.</p>
<p>If you are interested in getting the post itself and not just a link to the post, you can use the <code>c2c_get_next_or_loop_post()</code> and <code>c2c_get_previous_or_loop_post()</code> functions. If you just want the URL to the post, you can use <code>c2c_get_next_or_loop_post_url()</code> and <code>c2c_get_previous_or_loop_post_url()</code>.</p>
<p>Links: <a href="https://coffee2code.com/wp-plugins/loop-post-navigation-links/" rel="nofollow ugc">Plugin Homepage</a> | <a href="https://wordpress.org/plugins/loop-post-navigation-links/" rel="ugc">Plugin Directory Page</a> | <a href="https://github.com/coffee2code/loop-post-navigation-links/" rel="nofollow ugc">GitHub</a> | <a href="https://coffee2code.com" rel="nofollow ugc">Author Homepage</a></p>
<h3>Template Tags</h3>
<p>The plugin provides four template tags for use in your single-post theme templates.</p>
<h4>Functions</h4>
<ul>
<li>
<p><code>function c2c_next_or_loop_post_link( $format='%link &raquo;', $link='%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )</code><br />
Like WordPress’s <code>next_post_link()</code>, 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 <code>next_post_link()</code>, when on the last post in the sequence this function will link back to the first post in the sequence, creating a circular loop.</p>
</li>
<li>
<p><code>function c2c_get_next_or_loop_post_link( $format='%link &raquo;', $link='%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )</code><br />
Like `c2c_next_or_loop_post_link(), but returns the value without echoing it.</p>
</li>
<li>
<p><code>function c2c_previous_or_loop_post_link( $format='&laquo; %link', $link='%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )</code><br />
Like WordPress’s <code>previous_post_link()</code>, 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 <code>previous_post_link()</code>, when on the first post in the sequence this function will link to the last post in the sequence, creating a circular loop.</p>
</li>
<li>
<p><code>function c2c_get_previous_or_loop_post_link( $format='&laquo; %link', $link='%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )</code><br />
Like `c2c_get_previous_or_loop_post_link(), but returns the value without echoing it.</p>
</li>
<li>
<p><code>function c2c_get_next_or_loop_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )</code><br />
Like WordPress’s <code>get_adjacent_post()</code> 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.</p>
</li>
<li>
<p><code>function c2c_get_previous_or_loop_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )</code><br />
Like WordPress’s <code>get_adjacent_post()</code> 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.</p>
</li>
<li>
<p><code>function c2c_get_next_or_loop_post_url( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )</code><br />
Returns the URL for the next post or the post at the beginning of the series.</p>
</li>
<li>
<p><code>function c2c_get_previous_or_loop_post_url( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )</code><br />
Returns the URL for the previous post or the post at the end of the series.</p>
</li>
</ul>
<h4>Arguments</h4>
<ul>
<li>
<p><code>$format</code><br />
(optional) A percent-substitution string indicating the format of the entire output string. Use <code>%link</code> to represent the next/previous post being linked, or <code>%title</code> to represent the title of the next/previous post.</p>
</li>
<li>
<p><code>$link</code><br />
(optional) A percent-substitution string indicating the format of the link itself that gets created for the next/previous post. Use <code>%link</code> to represent the next/previous post being linked, or <code>%title</code> to represent the title of the next/previous post.</p>
</li>
<li>
<p><code>$in_same_term</code><br />
(optional) A boolean value (either true or false) indicating if the next/previous post should be in the current post’s same taxonomy term.</p>
</li>
<li>
<p><code>$excluded_terms</code><br />
(optional) An array or comma-separated string of category or term IDs to which posts cannot belong.</p>
</li>
<li>
<p><code>$taxonomy</code><br />
(optional) Taxonomy, if $in_same_term is true. Default ‘category’.</p>
</li>
</ul>
<h3>Examples</h3>
<pre><code><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>
</code></pre>
<p>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.</p>
<p><strong>c2c_previous_or_loop_post_link_output, c2c_next_or_loop_post_link_output (filters)</strong></p>
<p>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.</p>
<p>Arguments:</p>
<ul>
<li>$format         (string):       Link anchor format.</li>
<li>$link           (string):       Link permalink format.</li>
<li>$in_same_term   (bool):         Optional. Whether link should be in a same taxonomy term. Default is false.</li>
<li>$excluded_terms (array|string): Optional. Array or comma-separated list of excluded term IDs. Default is ”.</li>
<li>$previous       (bool):         Optional. Whether to display link to previous or next post. Default is true.</li>
<li>$taxonomy       (string):       Optional. Taxonomy, if $in_same_term is true. Default ‘category’.</li>
<li>$adjacent       (string):       Whether the post is previous or next.</li>
</ul>
<p>Example:</p>
<pre><code>  <?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 );
    ?>
</code></pre>
<p><strong>c2c_previous_or_loop_post_link_get, c2c_next_or_loop_post_link_get (filters)</strong></p>
<p>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.</p>
<p>Arguments:</p>
<ul>
<li>$output         (string):       The adjacent post link.</li>
<li>$format         (string):       Link anchor format.</li>
<li>$link           (string):       Link permalink format.</li>
<li>$post           (WP_Post):      The adjacent post.</li>
<li>$in_same_term   (bool):         Optional. Whether link should be in a same taxonomy term. Default is false.</li>
<li>$excluded_terms (array|string): Optional. Array or comma-separated list of excluded term IDs. Default is ”.</li>
<li>$previous       (bool):         Optional. Whether to display link to previous or next post. Default is true.</li>
<li>$taxonomy       (string):       Optional. Taxonomy, if $in_same_term is true. Default ‘category’.</li>
<li>$adjacent       (string):       Whether the post is previous or next.</li>
</ul>
<p><strong>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)</strong></p>
<p>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 <code>c2c_previous_or_loop_post_link()</code> and <code>c2c_next_or_loop_post_link()</code>, 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 <code>c2c_previous_or_loop_post_link()</code> and <code>c2c_next_or_loop_post_link()</code>.</p>
<p>Arguments:</p>
<ul>
<li>Same as for for <code>c2c_previous_or_loop_post_link()</code> and <code>c2c_next_or_loop_post_link()</code></li>
</ul>
<p>Example:</p>
<p>Instead of:</p>
<pre><code><?php c2c_previous_or_loop_post_link( '<span class="prev-or-loop-link">&laquo; %link</span>' ); ?>
</code></pre>
<p>Do:</p>
<pre><code><?php do_action( 'c2c_previous_or_loop_post_link', '<span class="prev-or-loop-link">&laquo; %link</span>' ); ?>
</code></pre>


Loop Post Navigation Links

Template tags (for use in single.php) to create post navigation loop (previous to first post is last post; next/after last post is first post).

<p>This plugin adds “← Previous” and “Next →” links to the “Edit Post” admin page if a previous and next post are present, respectively. The link titles (visible when hovering over the links) reveal the title of the previous/next post. The links link to the “Edit Post” admin page for the previous/next posts so that you may edit them.</p>
<p>By default, a previous/next post is determined by the next lower/higher valid post based on the date the post was created and which is also a post the user can edit. Other post criteria such as post type (draft, pending, etc), publish date, post author, category, etc, are not taken into consideration when determining the previous or next post.</p>
<p>Users can customize how post navigation ordering is handled via the “Screen Options” panel available at the top of every page when editing a post. A dropdown presents options to order navigation by: ‘ID’, ‘menu_order’, ‘post_date’, ‘post_modified’, ‘post_name’, and ‘post_title’. Post navigation can further be customized via filters (see Filters section).</p>
<p>NOTE: Be sure to save the post currently being edited (if you’ve made any changes) before navigating away to the previous/next post!</p>
<p>Links: <a href="http://coffee2code.com/wp-plugins/admin-post-navigation/" rel="nofollow ugc">Plugin Homepage</a> | <a href="https://wordpress.org/plugins/admin-post-navigation/" rel="ugc">Plugin Directory Page</a> | <a href="https://github.com/coffe2code/admin-post-navigation/" rel="nofollow ugc">GitHub</a> | <a href="http://coffee2code.com" rel="nofollow ugc">Author Homepage</a></p>
<h3>Filters</h3>
<p>The plugin is further customizable via six filters. Such code should ideally be put into a mu-plugin or site-specific plugin (which is beyond the scope of this readme to explain).</p>
<h4>c2c_admin_post_navigation_orderby (filter)</h4>
<p>The ‘c2c_admin_post_navigation_orderby’ filter allows you to change the post field used in the ORDER BY clause for the SQL to find the previous/next post. By default this is ‘post_date’ for non-hierarchical post types (such as posts) and ‘post_title’ for hierarchical post types (such as pages). If you wish to change this, hook this filter. Note: users can customize the post navigation order field for themselves on a per-post type basis via “Screen Options” (see FAQ and screenshot for more info).</p>
<p>Arguments:</p>
<ul>
<li>$field (string) The current ORDER BY field</li>
<li>$post_type (string) The post type being navigated</li>
<li>$user_id (int) The user’s ID</li>
</ul>
<p>Example:</p>
<pre><code>/**
 * Modify how Admin Post Navigation orders posts for navigation by changing the
 * ordering of pages by 'menu_order'.
 *
 * @param string $field     The field used to order posts for navigation.
 * @param string $post_type The post type being navigated.
 * @param int    $user_id.  The user's ID.
 * @return string
 */
function custom_order_apn( $field, $post_type, $user_id ) {
    // Only change the order for the 'page' post type.
    if ( 'page' === $post_type ) {
        $field = 'menu_order';
    }

    return $field;
}
add_filter( 'c2c_admin_post_navigation_orderby', 'custom_order_apn', 10, 3 );
</code></pre>
<h4>c2c_admin_post_navigation_post_statuses (filter)</h4>
<p>The ‘c2c_admin_post_navigation_post_statuses’ filter allows you to modify the list of post_statuses used as part of the search for the prev/next post. By default this array includes ‘draft’, ‘future’, ‘pending’, ‘private’, and ‘publish’. If you wish to change this, hook this filter. This is not typical usage for most users.</p>
<p>Arguments:</p>
<ul>
<li>$post_statuses (array) The array of valid post_statuses</li>
<li>$post_type (string) The post type</li>
</ul>
<p>Example:</p>
<pre><code>/**
 * Modify Admin Post Navigation to allow and disallow certain post statuses from being navigated.
 *
 * @param array  $post_statuses Post statuses permitted for admin navigation.
 * @param string $post_type     The post type.
 * @return array
 */
function change_apn_post_status( $post_statuses, $post_type ) {
    // Add a post status.
    // Note: by default these are already in the $post_statuses array: 'draft', 'future', 'pending', 'private', 'publish'
    $post_statuses[] = 'trash';

    // Remove post status(es).
    $post_statuses_to_remove = array( 'draft' ); // Customize here.
    if ( 'page' === $post_type ) {
        $post_statuses_to_remove[] = 'pending';
    }
    foreach ( $post_statuses_to_remove as $remove ) {
        if ( false !== $index = array_search( $remove, $post_statuses ) ) {
            unset( $post_statuses[ $index ] );
        }
    }

    return array_values( $post_statuses );
}
add_filter( 'c2c_admin_post_navigation_post_statuses', 'change_apn_post_status', 10, 2 );
</code></pre>
<h4>c2c_admin_post_navigation_post_types (filter)</h4>
<p>The ‘c2c_admin_post_navigation_post_types’ filter allows you to modify the list of post_types used as part of the search for the prev/next post. By default this array includes all available post types. If you wish to change this, hook this filter.</p>
<p>Arguments:</p>
<ul>
<li>$post_types (array) The array of valid post_types</li>
</ul>
<p>Examples:</p>
<pre><code>/**
 * Modify Admin Post Navigation to only allow navigating strictly for posts.
 *
 * @param array $post_types Post types that should have admin post navigation.
 * @return array
 */
function change_apn_post_types( $post_types ) {
    return array( 'post' );
}
add_filter( 'c2c_admin_post_navigation_post_types', 'change_apn_post_types' );



/**
 * Modify Admin Post Navigation to disallow navigation for the 'recipe' post type.
 *
 * @param array $post_types Post types that should have admin post navigation.
 * @return array
 */
function remove_recipe_apn_post_types( $post_types ) {
    if ( isset( $post_types['recipe'] ) ) {
        unset( $post_types['recipe'] ); // Removing a post type
    }
    return $post_types;
}
add_filter( 'c2c_admin_post_navigation_post_types', 'remove_recipe_apn_post_types' );
</code></pre>
<h4>c2c_admin_post_navigation_prev_text (filter)</h4>
<p>The ‘c2c_admin_post_navigation_prev_text’ filter allows you to change the link text used for the ‘Previous’ link. By default this is ‘← Previous’.</p>
<p>Arguments:</p>
<ul>
<li>$text (string) The ‘previous’ link text.</li>
</ul>
<p>Example:</p>
<pre><code>/**
 * Changes the text for the 'previous' link to 'Older' output by the Admin Post Navigation plugin.
 *
 * @param string $text The text used to indicate the 'next' post.
 * @return string
 */
function my_c2c_admin_post_navigation_prev_text( $text ) {
    return 'Older';
}
add_filter( 'c2c_admin_post_navigation_prev_text', 'my_c2c_admin_post_navigation_prev_text' );
</code></pre>
<h4>c2c_admin_post_navigation_next_text (filter)</h4>
<p>The ‘c2c_admin_post_navigation_next_text’ filter allows you to change the link text used for the ‘Next’ link. By default this is ‘Next →’.</p>
<p>Arguments:</p>
<ul>
<li>$text (string) The ‘next’ link text.</li>
</ul>
<p>Example:</p>
<pre><code>/**
 * Changes the text for the 'next' link to 'Newer' output by the Admin Post Navigation plugin.
 *
 * @param string $text The text used to indicate the 'next' post.
 * @return string
 */
function my_c2c_admin_post_navigation_next_text( $text ) {
    return 'Newer';
}
add_filter( 'c2c_admin_post_navigation_next_text', 'my_c2c_admin_post_navigation_next_text' );
</code></pre>
<h4>c2c_admin_post_navigation_display (filter)</h4>
<p>The ‘c2c_admin_post_navigation_display’ filter allows you to customize the output links for the post navigation.</p>
<p>Arguments:</p>
<ul>
<li>$text (string) The current output for the prev/next navigation link</li>
</ul>
<p>Example:</p>
<pre><code>/**
 * Change the markup displayed by the Admin Post Navigation plugin.
 *
 * @param string $text The text being output by the plugin.
 * @return string
 */
function override_apn_display( $text ) {
    // Simplistic example. You could preferably make the text bold using CSS.
    return '<strong>' . $text . '</strong>';
}
add_filter( 'c2c_admin_post_navigation_display', 'override_apn_display' );
</code></pre>


Admin Post Navigation

Adds links to navigate to the next and previous posts when editing a post in the WordPress admin.

Loop Post Navigation Links vs Admin Post Navigation