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
3802           $link .= $args['add_fragment'];
3803
3804           /**
3805            * Filters the paginated links for the given archive pages.
3806            *
3807            * @since 3.0.0
3808            *
3809            * @param string $link The paginated link URL.
3810            */
3811           $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['prev_text'] . '</a>';
3812      endif;
3813      for ( $n = 1; $n <= $total; $n++ ) :
3814           if ( $n == $current ) :
3815                $page_links[] = "<span aria-current='" . esc_attr( $args['aria_current'] ) . "' class='page-numbers current'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</span>";
3816                $dots = true;
3817           else :
3818                if ( $args['show_all'] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
3819                     $link = str_replace( '%_%', 1 == $n ? '' : $args['format'], $args['base'] );
3820                     $link = str_replace( '%#%', $n, $link );
3821                     if ( $add_args )
3822                          $link = add_query_arg( $add_args, $link );
3823                     $link .= $args['add_fragment'];
3824
3825                     /** This filter is documented in wp-includes/general-template.php */
3826                     $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>";
3827                     $dots = true;
3828                elseif ( $dots && ! $args['show_all'] ) :
3829                     $page_links[] = '<span class="page-numbers dots">' . __( '&hellip;' ) . '</span>';
3830                     $dots = false;
3831                endif;
3832           endif;
3833      endfor;
3834      if ( $args['prev_next'] && $current && $current < $total ) :
3835           $link = str_replace( '%_%', $args['format'], $args['base'] );
3836           $link = str_replace( '%#%', $current + 1, $link );
3837           if ( $add_args )
3838                $link = add_query_arg( $add_args, $link );
3839           $link .= $args['add_fragment'];
3840
3841           /** This filter is documented in wp-includes/general-template.php */
3842           $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['next_text'] . '</a>';
3843      endif;
3844      switch ( $args['type'] ) {
3845           case 'array' :
3846                return $page_links;
3847
3848           case 'list' :
3849                $r .= "<ul class='page-numbers'>\n\t<li>";
3850                $r .= join("</li>\n\t<li>", $page_links);
3851                $r .= "</li>\n</ul>\n";