当前浏览:首页 / WordPress函数 / wp_link_pages()

wp_link_pages( string|array $args = '' )

页面列表的格式化输出

linkmore...

pagemore...


描述

显示页面的分页链接(即包含<!--nextpage-->快速标签一次或多次)。此标签必须在循环中。


参数

$args

(string|array) (可选) 默认参数的数组或字符串。

  • 'before'
    (string) 前置添加到每个链接的HTML或文本,默认是 <p> Pages:
  • 'after'
    (string) 追加到每个链接的HTML或文本,默认是 </p>
  • 'link_before'
    (string) 前置添加到每个链接的HTML或文本,在 <a> 标签内。同样添加在无链接的当前项之前。
  • 'link_after'
    (string) 追加到每个链接的HTML或文本,在 <a> 标签内。同样追加在无链接的当前项之后。
  • 'aria_current'
    (string) aria-current 属性的值. 可能的值:'page', 'step', 'location', 'date', 'time', 'true', 'false'. 默认是 'page'
  • 'next_or_number'
    (string) 是否使用页码,有效值是number和next。默认是 'number'
  • 'separator'
    (string) 分页链接之间的文本,默认 ' '
  • 'nextpagelink'
    (string) 下一页链接的链接文本(如果可用)默认是 'Next Page'
  • 'previouspagelink'
    (string) 上一页链接的链接文本(如果可用)默认是 'Previous Page'
  • 'pagelink'
    (string) 页码的格式字符串,参数字符串中的 % 将被替换成页码,所以 'Page %' 生成 "Page 1", "Page 2", 等等。默认是 '%' 只有页码。
  • 'echo'
    (int|bool) 是否输出,接受 1|true 或 0|false,默认 1|true

默认值: ''


返回

(string) 以HTML格式化输出



源码

查看源码 官方文档


更新日志

版本描述
5.1.0添加了aria_current参数
1.2.0开始引入

使用示例

  • 示例1

    使用上一个/下一个选项(而不是页码);自定义文本、HTML和类:

    <?php
    $args = array (
    	'before'      		=> '<div class="page-links-XXX"><span class="page-link-text">' . __( 'More pages: ', 'textdomain' ) . '</span>',
    	'after'       		=> '</div>',
    	'link_before' 		=> '<span class="page-link">',
    	'link_after'  		=> '</span>',
    	'next_or_number'	=> 'next',
    	'separator'			=> ' | ',
    	'nextpagelink'		=> __( 'Next &raquo', 'textdomain' ),
    	'previouspagelink'	=> __( '&laquo Previous', 'textdomain' ),
    );
    
    wp_link_pages( $args );
    ?>
    

    上述内容在页面上显示如下:

    More pages: « Previous | Next »

    (“前一页”和“下一页”链接如果分别位于第一页或最后一页,则不会打印。)

  • 示例2

    示例:
    如果页面(或文章)的内容至少有一个<!--nextpage-->标记(该代码位于循环中),则打印链接的页码(“页码:1、2、3”),当前页码上没有链接,默认情况下在<p>标记内:

    <?php wp_link_pages(); ?>
  • 示例3

    在其他HTML标记中显示页面链接:
    将页面链接打印为无序列表中的列表项,并使用自定义类名:

    <?php wp_link_pages( 'before=<ul class="page-links">&after=</ul>&link_before=<li class="page-link">&link_after=</li>' ); ?>
  • 示例4

    从Codex迁移:

    默认用法

    默认情况下,使用“下一页”和“上一页”显示带有前后段落标记的页面链接,并将其与页码一起列出,如第1页、第2页等。

    <?php wp_link_pages(); ?>
  • 示例5

    从Codex迁移:

    段落标签中的页面链接

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

    从Codex迁移:

    DIV中的页面链接

    在DIV中显示 page-links 作为CSS类

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

    从Codex迁移:

    在 content.php 中添加 wp_link_pages

    此代码段可以直接添加到您的content.php或single.php文件位于您希望分页显示的位置。

    <?php wp_link_pages( array(
    	'before'      => '<div class="page-links"><span class="page-links-title">' . __( 'Pages:', 'twentyfourteen' ) . '</span>',
    	'after'       => '</div>',
    	'link_before' => '<span>',
    	'link_after'  => '</span>',
    	) );
    ?>