Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: paginate_links

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

This hook occurs 3 times in this file.

Line Code
3317           $link .= $args['add_fragment'];
3318
3319           /**
3320            * Filters the paginated links for the given archive pages.
3321            *
3322            * @since 3.0.0
3323            *
3324            * @param string $link The paginated link URL.
3325            */
3326           $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['prev_text'] . '</a>';
3327      endif;
3328      for ( $n = 1; $n <= $total; $n++ ) :
3329           if ( $n == $current ) :
3330                $page_links[] = "<span class='page-numbers current'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</span>";
3331                $dots = true;
3332           else :
3333                if ( $args['show_all'] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
3334                     $link = str_replace( '%_%', 1 == $n ? '' : $args['format'], $args['base'] );
3335                     $link = str_replace( '%#%', $n, $link );
3336                     if ( $add_args )
3337                          $link = add_query_arg( $add_args, $link );
3338                     $link .= $args['add_fragment'];
3339
3340                     /** This filter is documented in wp-includes/general-template.php */
3341                     $page_links[] = "<a class='page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</a>";
3342                     $dots = true;
3343                elseif ( $dots && ! $args['show_all'] ) :
3344                     $page_links[] = '<span class="page-numbers dots">' . __( '&hellip;' ) . '</span>';
3345                     $dots = false;
3346                endif;
3347           endif;
3348      endfor;
3349      if ( $args['prev_next'] && $current && $current < $total ) :
3350           $link = str_replace( '%_%', $args['format'], $args['base'] );
3351           $link = str_replace( '%#%', $current + 1, $link );
3352           if ( $add_args )
3353                $link = add_query_arg( $add_args, $link );
3354           $link .= $args['add_fragment'];
3355
3356           /** This filter is documented in wp-includes/general-template.php */
3357           $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['next_text'] . '</a>';
3358      endif;
3359      switch ( $args['type'] ) {
3360           case 'array' :
3361                return $page_links;
3362
3363           case 'list' :
3364                $r .= "<ul class='page-numbers'>\n\t<li>";
3365                $r .= join("</li>\n\t<li>", $page_links);
3366                $r .= "</li>\n</ul>\n";