Skip to content

Commit

Permalink
Added Loop Pagination script.
Browse files Browse the repository at this point in the history
  • Loading branch information
Rarst committed Jan 12, 2014
1 parent 1afebe4 commit 6a9f66f
Show file tree
Hide file tree
Showing 3 changed files with 119 additions and 1 deletion.
2 changes: 1 addition & 1 deletion archive-wpapi-function.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@

<?php endif; ?>

TODO pagination
<?php loop_pagination(); ?>

</div>
<!-- /wrapper -->
Expand Down
5 changes: 5 additions & 0 deletions functions.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

require __DIR__ . '/template-tags.php';

if ( ! function_exists( 'loop_pagination' ) ) {
require __DIR__ . '/php/loop-pagination.php';
}


add_action( 'init', __NAMESPACE__ . '\\init' );


Expand Down
113 changes: 113 additions & 0 deletions php/loop-pagination.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
<?php
/**
* Loop Pagination - A WordPress script for creating paginated links on archive-type pages.
*
* The Loop Pagination script was designed to give theme authors a quick way to paginate archive-type
* (archive, search, and blog) pages without having to worry about which of the many plugins a user might
* possibly be using. Instead, they can simply build pagination right into their themes.
*
* 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.
*
* @package LoopPagination
* @version 0.3.0
* @author Justin Tadlock <justin@justintadlock.com>
* @copyright Copyright (c) 2010 - 2013, Justin Tadlock
* @link http://themehybrid.com/docs/tutorials/loop-pagination
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*/

/**
* Loop pagination function for paginating loops with multiple posts. This should be used on archive, blog, and
* search pages. It is not for singular views.
*
* @since 0.1.0
* @access public
* @uses paginate_links() Creates a string of paginated links based on the arguments given.
* @param array $args Arguments to customize how the page links are output.
* @return string $page_links
*/
function loop_pagination( $args = array() ) {
global $wp_rewrite, $wp_query;

/* If there's not more than one page, return nothing. */
if ( 1 >= $wp_query->max_num_pages )
return;

/* Get the current page. */
$current = ( get_query_var( 'paged' ) ? absint( get_query_var( 'paged' ) ) : 1 );

/* Get the max number of pages. */
$max_num_pages = intval( $wp_query->max_num_pages );

/* Get the pagination base. */
$pagination_base = $wp_rewrite->pagination_base;

/* Set up some default arguments for the paginate_links() function. */
$defaults = array(
'base' => add_query_arg( 'paged', '%#%' ),
'format' => '',
'total' => $max_num_pages,
'current' => $current,
'prev_next' => true,
//'prev_text' => __( '&laquo; Previous' ), // This is the WordPress default.
//'next_text' => __( 'Next &raquo;' ), // This is the WordPress default.
'show_all' => false,
'end_size' => 1,
'mid_size' => 1,
'add_fragment' => '',
'type' => 'plain',

// Begin loop_pagination() arguments.
'before' => '<nav class="pagination loop-pagination">',
'after' => '</nav>',
'echo' => true,
);

/* Add the $base argument to the array if the user is using permalinks. */
if ( $wp_rewrite->using_permalinks() && !is_search() )
$defaults['base'] = user_trailingslashit( trailingslashit( get_pagenum_link() ) . "{$pagination_base}/%#%" );

/* Allow developers to overwrite the arguments with a filter. */
$args = apply_filters( 'loop_pagination_args', $args );

/* Merge the arguments input with the defaults. */
$args = wp_parse_args( $args, $defaults );

/* Don't allow the user to set this to an array. */
if ( 'array' == $args['type'] )
$args['type'] = 'plain';

/* Get the paginated links. */
$page_links = paginate_links( $args );

/* Remove 'page/1' from the entire output since it's not needed. */
$page_links = preg_replace(
array(
"#(href=['\"].*?){$pagination_base}/1(['\"])#", // 'page/1'
"#(href=['\"].*?){$pagination_base}/1/(['\"])#", // 'page/1/'
"#(href=['\"].*?)\?paged=1(['\"])#", // '?paged=1'
"#(href=['\"].*?)&\#038;paged=1(['\"])#" // '&#038;paged=1'
),
'$1$2',
$page_links
);

/* Wrap the paginated links with the $before and $after elements. */
$page_links = $args['before'] . $page_links . $args['after'];

/* Allow devs to completely overwrite the output. */
$page_links = apply_filters( 'loop_pagination', $page_links );

/* Return the paginated links for use in themes. */
if ( $args['echo'] )
echo $page_links;
else
return $page_links;
}

?>

0 comments on commit 6a9f66f

Please sign in to comment.