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
3351           $link .= $args['add_fragment'];
3352
3353           /**
3354            * Filters the paginated links for the given archive pages.
3355            *
3356            * @since 3.0.0
3357            *
3358            * @param string $link The paginated link URL.
3359            */
3360           $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['prev_text'] . '</a>';
3361      endif;
3362      for ( $n = 1; $n <= $total; $n++ ) :
3363           if ( $n == $current ) :
3364                $page_links[] = "<span class='page-numbers current'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</span>";
3365                $dots = true;
3366           else :
3367                if ( $args['show_all'] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
3368                     $link = str_replace( '%_%', 1 == $n ? '' : $args['format'], $args['base'] );
3369                     $link = str_replace( '%#%', $n, $link );
3370                     if ( $add_args )
3371                          $link = add_query_arg( $add_args, $link );
3372                     $link .= $args['add_fragment'];
3373
3374                     /** This filter is documented in wp-includes/general-template.php */
3375                     $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>";
3376                     $dots = true;
3377                elseif ( $dots && ! $args['show_all'] ) :
3378                     $page_links[] = '<span class="page-numbers dots">' . __( '&hellip;' ) . '</span>';
3379                     $dots = false;
3380                endif;
3381           endif;
3382      endfor;
3383      if ( $args['prev_next'] && $current && $current < $total ) :
3384           $link = str_replace( '%_%', $args['format'], $args['base'] );
3385           $link = str_replace( '%#%', $current + 1, $link );
3386           if ( $add_args )
3387                $link = add_query_arg( $add_args, $link );
3388           $link .= $args['add_fragment'];
3389
3390           /** This filter is documented in wp-includes/general-template.php */
3391           $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['next_text'] . '</a>';
3392      endif;
3393      switch ( $args['type'] ) {
3394           case 'array' :
3395                return $page_links;
3396
3397           case 'list' :
3398                $r .= "<ul class='page-numbers'>\n\t<li>";
3399                $r .= join("</li>\n\t<li>", $page_links);
3400                $r .= "</li>\n</ul>\n";