Advertisements

paginate_links

Definition:
function paginate_links( $args = '' ) {}

Retrieve paginated link for archive post pages.
Technically, the function can be used to create paginated link list for any area. The ‘base’ argument is used to reference the url, which will be used to create the paginated links. The ‘format’ argument is then used for replacing the page number. It is however, most likely and by default, to be used on the archive post pages.

Parameters

  • string|array $args: Optional. Override defaults.

Return values

returns:String of page links or array of page links.

Defined filters

  • paginate_links
    apply_filters( 'paginate_links', $link )
  • paginate_links
    apply_filters( 'paginate_links', $link )
  • paginate_links
    apply_filters( 'paginate_links', $link )

Source code

function paginate_links( $args = '' ) {

	$defaults = array(

		'base' => '%_%', // http://example.com/all_posts.php%_% : %_% is replaced by format (below)

		'format' => '?page=%#%', // ?page=%#% : %#% is replaced by the page number

		'total' => 1,

		'current' => 0,

		'show_all' => false,

		'prev_next' => true,

		'prev_text' => __('« Previous'),

		'next_text' => __('Next »'),

		'end_size' => 1,

		'mid_size' => 2,

		'type' => 'plain',

		'add_args' => false, // array of query args to add

		'add_fragment' => ''

	);



	$args = wp_parse_args( $args, $defaults );

	extract($args, EXTR_SKIP);



	// Who knows what else people pass in $args

	$total = (int) $total;

	if ( $total < 2 )

		return;

	$current  = (int) $current;

	$end_size = 0  < (int) $end_size ? (int) $end_size : 1; // Out of bounds?  Make it the default.

	$mid_size = 0 <= (int) $mid_size ? (int) $mid_size : 2;

	$add_args = is_array($add_args) ? $add_args : false;

	$r = '';

	$page_links = array();

	$n = 0;

	$dots = false;



	if ( $prev_next && $current && 1 < $current ) :

		$link = str_replace('%_%', 2 == $current ? '' : $format, $base);

		$link = str_replace('%#%', $current - 1, $link);

		if ( $add_args )

			$link = add_query_arg( $add_args, $link );

		$link .= $add_fragment;

		$page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $prev_text . '</a>';

	endif;

	for ( $n = 1; $n <= $total; $n++ ) :

		$n_display = number_format_i18n($n);

		if ( $n == $current ) :

			$page_links[] = "<span class='page-numbers current'>$n_display</span>";

			$dots = true;

		else :

			if ( $show_all || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :

				$link = str_replace('%_%', 1 == $n ? '' : $format, $base);

				$link = str_replace('%#%', $n, $link);

				if ( $add_args )

					$link = add_query_arg( $add_args, $link );

				$link .= $add_fragment;

				$page_links[] = "<a class='page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>$n_display</a>";

				$dots = true;

			elseif ( $dots && !$show_all ) :

				$page_links[] = '<span class="page-numbers dots">' . __( '&hellip;' ) . '</span>';

				$dots = false;

			endif;

		endif;

	endfor;

	if ( $prev_next && $current && ( $current < $total || -1 == $total ) ) :

		$link = str_replace('%_%', $format, $base);

		$link = str_replace('%#%', $current + 1, $link);

		if ( $add_args )

			$link = add_query_arg( $add_args, $link );

		$link .= $add_fragment;

		$page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $next_text . '</a>';

	endif;

	switch ( $type ) :

		case 'array' :

			return $page_links;

			break;

		case 'list' :

			$r .= "<ul class='page-numbers'>\n\t<li>";

			$r .= join("</li>\n\t<li>", $page_links);

			$r .= "</li>\n</ul>\n";

			break;

		default :

			$r = join("\n", $page_links);

			break;

	endswitch;

	return $r;

}

2477

Advertisements

No comments yet... Be the first to leave a reply!

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: