Custom Pagination without WordPress Plugins


On day 9 of our Advents Calendar we show a custom pagination function which allows a user to insert custom next, previous or numbered page links into a post. Use the follow code for an custom plugin or insert the function in your theme, inside the functions.php. Please see the second code-area for an example to hook inside the function for custom parameters.

Example Screenshots

The function

Now the function for the pagination

function fb_paging_bar( $args = array() ) {
	
	$defaults = array(
		'range'           => 4,
		'custom_query'    => FALSE,
		'previous_string' => __( '«««', FB_GREYFOTO_TEXTDOMAIN ),
		'next_string'     => __( '»»»', FB_GREYFOTO_TEXTDOMAIN ),
		'view_fp'         => TRUE,
		'view_lp'         => TRUE,
		'before_output'   => ''
	);
	
	$args = wp_parse_args( 
		$args, 
		apply_filters( 'fb_paging_bar_defaults', $defaults )
	);
	
	$args['range'] = (int) $args['range'] - 1;
	if ( !$args['custom_query'] )
		$args['custom_query'] = @$GLOBALS['wp_query'];
	$count = (int) $args['custom_query']->max_num_pages;
	$page  = intval( get_query_var( 'paged' ) );
	$ceil  = ceil( $args['range'] / 2 );
	
	if ( $count <= 1 )
		return FALSE;
	
	if ( !$page )
		$page = 1;
	
	if ( $count > $args['range'] ) {
		if ( $page <= $args['range'] ) {
			$min = 1;
			$max = $args['range'] + 1;
		} elseif ( $page >= ($count - $ceil) ) {
			$min = $count - $args['range'];
			$max = $count;
		} elseif ( $page >= $args['range'] && $page < ($count - $ceil) ) {
			$min = $page - $ceil;
			$max = $page + $ceil;
		}
	} else {
		$min = 1;
		$max = $count;
	}
	
	$echo = '';
	$previous = intval($page) - 1;
	$previous = esc_attr( get_pagenum_link($previous) );
	if ( $previous && (1 != $page) )
		$echo .= '' . $args['previous_string'] . '';
	$firstpage = esc_attr( get_pagenum_link(1) );
	
	if ( $args['view_fp'] && $firstpage && (1 != $page) )
		$echo .= '' . __( 'First', FB_GREYFOTO_TEXTDOMAIN ) . '';
	
	if ( !empty($min) && !empty($max) ) {
		for( $i = $min; $i <= $max; $i++ ) {
			if ($page == $i) {
				$echo .= '' . str_pad( (int)$i, 2, '0', STR_PAD_LEFT ) . '';
			} else {
				$echo .= sprintf( '%002d', esc_attr( get_pagenum_link($i) ), $i );
			}
		}
	}
	
	if ($args['view_lp']) {
		$lastpage = esc_attr( get_pagenum_link($count) );
		if ( $lastpage && ($count != $page) ) {
			$count = str_pad( (int)$count, 2, '0', STR_PAD_LEFT );
			$echo .= '' . __( 'Last', FB_GREYFOTO_TEXTDOMAIN ) . '(' . $count . ')' . '';
		}
	}
	
	$next = intval($page) + 1;
	$next = esc_attr( get_pagenum_link($next) );
	if ($next && ($count != $page) )
		$echo .= '' . $args['next_string'] . '';
	
	if ( isset($echo) )
		echo $args['before_output'] . $echo . $args['after_output'];
}

For use the function inside the templates use the follow syntax:


Example for custom arguments

For custom arguments, please use the filter. Also an example for this solution.

function change_fb_paging_bar_defaults($args) {
	
	$args['previous_string'] = ''; // empty string
	$args['next_string'] = '';
	
	return $args;
}
add_filter('fb_paging_bar_defaults', 'change_fb_paging_bar_defaults');

Posted

in

by

Comments

3 responses to “Custom Pagination without WordPress Plugins”

  1. Jay Avatar
    Jay

    OR! Or… you can use the paginate_links function included in WordPress.. See Codex: http://codex.wordpress.org/Function_Reference/paginate_links

  2. Umbrovskis Avatar

    . __( 'Last', FB_GREYFOTO_TEXTDOMAIN ) . '(' . $count . ')' . '';

    should be an extra space: before count (‘ . $count . ‘)
    . __( 'Last', FB_GREYFOTO_TEXTDOMAIN ) . ' (' . $count . ')' . '';

  3. Frank Avatar

    @Jay: thanks for the link, i dont know this function – i will see, many thanks