Codex

Template Tags/wp link pages

Contents

Description

Displays page-links for paginated posts (i.e. includes the <!--nextpage--> Quicktag one or more times). This works in much the same way as link_pages(), the difference being that arguments are given in query string format. This tag must be within The_Loop.

Usage

 <?php wp_link_pages( $args ); ?> 

Default Usage

 <?php $args = array(
    'before'           => '<p>' . __('Pages:'),
    'after'            => '</p>',
    'link_before'      => ,
    'link_after'       => ,
    'next_or_number'   => 'number',
    'nextpagelink'     => __('Next page'),
    'previouspagelink' => __('Previous page'),
    'pagelink'         => '%',
    'more_file'        => ,
    'echo'             => 1 ); ?> 

Parameters

before 
(string) Text to put before all the links. Defaults to <p>Pages:.
after 
(string) Text to put after all the links. Defaults to </p>.
link_before 
(string) Text that goes before the text of the link. Defaults to (blank). Version 2.7 or later required.
link_after 
(string) Text that goes after the text of the link. Defaults to (blank). Version 2.7 or later required.
next_or_number 
(string) Indicates whether page numbers should be used. Valid values are:
  • number (Default)
  • next (Valid in WordPress 1.5 or after)
nextpagelink 
(string) Text for link to next page. Defaults to Next page. (Valid in WordPress 1.5 or after)
previouspagelink
(string) Text for link to previous page. Defaults to Previous page. (Valid in WordPress 1.5 or after)
pagelink 
(string) Format string for page numbers.  % in the string will be replaced with the number, so Page % would generate "Page 1", "Page 2", etc. Defaults to %.
more_file 
(string) Page the links should point to. Defaults to the current page.
echo 
(boolean) Toggles whether to echo or return the result. The default is true. Valid values:
  • 1 (True) - Default
  • 0 (False)

Examples

Default Usage

Displays page-links by default with paragraph tags before and after, using Next page and Previous page, listing them with page numbers as Page 1, Page 2 and so on. 

<?php wp_link_pages(); ?>

Page-links in Paragraph Tags

Displays page-links wrapped in paragraph tags. 

<?php wp_link_pages('before=<p>&after=</p>&next_or_number=number&pagelink=page %'); ?>

Page-links in DIV

Displays page-links in DIV for CSS reference as <div id="page-links">. 

<?php wp_link_pages('before=<div id="page-links">&after=</div>'); ?>

Change Log

Since: 0.71

Source File

wp_link_pages() is located in wp-includes/post-template.php.

Related

the_ID, the_title, the_title_attribute, single_post_title, the_title_rss, the_content, the_content_rss, the_excerpt, the_excerpt_rss, wp_link_pages, next_post_link, next_posts_link, previous_post_link, previous_posts_link, posts_nav_link, sticky_class, the_meta

See also index of Function Reference and index of Template Tags.
Retrieved from "http://codex.wordpress.org/Template_Tags/wp_link_pages"

Codex Resources