wp_link_pages()

You are here:

wp_link_pages( string|array $args =  )

The formatted output of a list of pages.

Description Description

Displays page links for paginated posts (i.e. including the <!--nextpage--> Quicktag one or more times). This tag must be within The Loop.


Top ↑

Parameters Parameters

$args

(string|array) (Optional) Array or string of default arguments.

  • ‘before’
    (string) HTML or text to prepend to each link. Default is <p> Pages:.
  • ‘after’
    (string) HTML or text to append to each link. Default is </p>.
  • ‘link_before’
    (string) HTML or text to prepend to each link, inside the <a> tag. Also prepended to the current item, which is not linked.
  • ‘link_after’
    (string) HTML or text to append to each Pages link inside the <a> tag. Also appended to the current item, which is not linked.
  • ‘aria_current’
    (string) The value for the aria-current attribute. Possible values are ‘page’, ‘step’, ‘location’, ‘date’, ‘time’, ‘true’, ‘false’. Default is ‘page’.
  • ‘next_or_number’
    (string) Indicates whether page numbers should be used. Valid values are number and next. Default is ‘number’.
  • ‘separator’
    (string) Text between pagination links. Default is ‘ ‘.
  • ‘nextpagelink’
    (string) Link text for the next page link, if available. Default is ‘Next Page’.
  • ‘previouspagelink’
    (string) Link text for the previous page link, if available. Default is ‘Previous Page’.
  • ‘pagelink’
    (string) Format string for page numbers. The % in the parameter string will be replaced with the page number, so ‘Page %’ generates “Page 1”, “Page 2”, etc. Defaults to ‘%’, just the page number.
  • ‘echo’
    (int|bool) Whether to echo or not. Accepts 1|true or 0|false. Default 1|true.

 

Default value: ”


Top ↑

Return Return

(string) Formatted output in HTML.


Top ↑

Source Source

File: wp-includes/post-template.php

925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
function wp_link_pages( $args = '' ) {
    global $page, $numpages, $multipage, $more;
 
    $defaults = array(
        'before'           => '<p class="post-nav-links">' . __( 'Pages:' ),
        'after'            => '</p>',
        'link_before'      => '',
        'link_after'       => '',
        'aria_current'     => 'page',
        'next_or_number'   => 'number',
        'separator'        => ' ',
        'nextpagelink'     => __( 'Next page' ),
        'previouspagelink' => __( 'Previous page' ),
        'pagelink'         => '%',
        'echo'             => 1,
    );
 
    $parsed_args = wp_parse_args( $args, $defaults );
 
    /**
     * Filters the arguments used in retrieving page links for paginated posts.
     *
     * @since 3.0.0
     *
     * @param array $parsed_args An array of arguments for page links for paginated posts.
     */
    $parsed_args = apply_filters( 'wp_link_pages_args', $parsed_args );
 
    $output = '';
    if ( $multipage ) {
        if ( 'number' === $parsed_args['next_or_number'] ) {
            $output .= $parsed_args['before'];
            for ( $i = 1; $i <= $numpages; $i++ ) {
                $link = $parsed_args['link_before'] . str_replace( '%', $i, $parsed_args['pagelink'] ) . $parsed_args['link_after'];
                if ( $i != $page || ! $more && 1 == $page ) {
                    $link = _wp_link_page( $i ) . $link . '</a>';
                } elseif ( $i === $page ) {
                    $link = '<span class="post-page-numbers current" aria-current="' . esc_attr( $parsed_args['aria_current'] ) . '">' . $link . '</span>';
                }
                /**
                 * Filters the HTML output of individual page number links.
                 *
                 * @since 3.6.0
                 *
                 * @param string $link The page number HTML output.
                 * @param int    $i    Page number for paginated posts' page links.
                 */
                $link = apply_filters( 'wp_link_pages_link', $link, $i );
 
                // Use the custom links separator beginning with the second link.
                $output .= ( 1 === $i ) ? ' ' : $parsed_args['separator'];
                $output .= $link;
            }
            $output .= $parsed_args['after'];
        } elseif ( $more ) {
            $output .= $parsed_args['before'];
            $prev    = $page - 1;
            if ( $prev > 0 ) {
                $link = _wp_link_page( $prev ) . $parsed_args['link_before'] . $parsed_args['previouspagelink'] . $parsed_args['link_after'] . '</a>';
 
                /** This filter is documented in wp-includes/post-template.php */
                $output .= apply_filters( 'wp_link_pages_link', $link, $prev );
            }
            $next = $page + 1;
            if ( $next <= $numpages ) {
                if ( $prev ) {
                    $output .= $parsed_args['separator'];
                }
                $link = _wp_link_page( $next ) . $parsed_args['link_before'] . $parsed_args['nextpagelink'] . $parsed_args['link_after'] . '</a>';
 
                /** This filter is documented in wp-includes/post-template.php */
                $output .= apply_filters( 'wp_link_pages_link', $link, $next );
            }
            $output .= $parsed_args['after'];
        }
    }
 
    /**
     * Filters the HTML output of page links for paginated posts.
     *
     * @since 3.6.0
     *
     * @param string $output HTML output of paginated posts' page links.
     * @param array  $args   An array of arguments.
     */
    $html = apply_filters( 'wp_link_pages', $output, $args );
 
    if ( $parsed_args['echo'] ) {
        echo $html;
    }
    return $html;
}


Top ↑

Changelog Changelog

Changelog
VersionDescription
5.1.0Added the aria_current argument.
1.2.0Introduced.
Was this article helpful?
Dislike 0
Views: 3

Cart

Log in

Create an Account
Back to Top