参数
$argsarray可选-
默认分页参数，请参见paginate_links().
screen_reader_textstring导航元素的屏幕阅读器文本。
默认 'Posts navigation'。aria_labelstring导航元素的ArIA标签（label）文本。默认为'Posts'。classstring导航元素的自定义类。默认为'pagination'。
更多参数来自：paginate_links( ... $args )
用于为存档生成分页链接的参数数组或字符串。
basestring分页url的基础。formatstring分页结构的格式。totalint总页数，默认值为WP_Query的max_num_pages或1。currentint当前页码，默认值为'paged'查询变量或1。aria_currentstringaria-current属性的值。可能的值为'page'、'step'、'location'、'date'、'time'、'true'、'false'。默认值为'page'。show_allbool是否显示所有页面。默认值为false。end_sizeint开始和结束列表边缘上有多少个数字。
默认 1mid_sizeint当前页码两侧有多少个数字。默认值为2。prev_nextbool是否在列表中包含上一页和下一页链接。默认情况下为true。prev_textbool上一页的文本，默认值为'« Previous'。next_textbool下一页的文本。默认为'Next »'。typestring控制返回值的格式。可能的值为'plain'、'array'和'list'。默认值为'plain'。add_argsarray要添加的查询参数数组。默认值为false。add_fragmentstring要附加到每个链接的字符串。before_page_numberstring出现在页码之前的字符串。after_page_numberstring要附加在页码之后的字符串。
默认：
array()
返回
string 分页链接的标记。
源码
更新日志
| 版本 | 描述 |
|---|---|
| 5.5.0 | 添加了class参数。 |
| 5.3.0 | 添加了aria_label参数。 |
| 4.1.0 | 开始引入 |
使用示例
$args参数传递给paginate_links()函数。默认值：
<?php $args = array( 'base' => '%_%', 'format' => '?paged=%#%', 'total' => 1, 'current' => 0, 'show_all' => false, 'end_size' => 1, 'mid_size' => 2, 'prev_next' => true, 'prev_text' => __('« Previous'), 'next_text' => __('Next »'), 'type' => 'plain', 'add_args' => false, 'add_fragment' => '', 'before_page_number' => '', 'after_page_number' => '' ); ?>// Usage Example $pagination = get_the_posts_pagination( array( 'mid_size' => 2, 'prev_text' => __( 'Newer', 'textdomain' ), 'next_text' => __( 'Older', 'textdomain' ), ) );