WordPress当前文章评论分页函数:paginate_comments_links

WordPress函数paginate_comments_links用于输出当前文章评论分页链接。

paginate_comments_links( string|array $args = array() )

函数参数

$args

数组或字符串

paginate_comments_links()函数$args参数默认值如下:

$args = array(
	'base' => add_query_arg( 'cpage', '%#%' ),
	'format' => '',
	'total' => $max_page,
	'current' => $page,
	'echo' => true,
	'add_fragment' => '#comments'
);

可用值如下:

base

字符串

分页链接的基本URL,类似如下的链接:

https://www.beizigen.com/post/wordpress-function-paginate_comments_links/comment-page-1

以上格式URL可以使用get_pagenum_link()函数返回:

html_entity_decode( get_pagenum_link() );

format

字符串

分页结构的格式。例如:

?page=%#%

total

整数

总页数,可以使用WordPress全局变量$wp_query获取。

$wp_query->max_num_pages

current

整数

当前页码,可以使用get_query_var()函数获取:

get_query_var( 'paged' );

aria_current

字符串

aria-current属性的值

show_all

布尔值,默认值:false

是否显示所有页面。

end_size

整数,默认值:1

总页数量超过要显示的页数时,在分页链接中,上一页和下一页紧邻的页码显示数量。

mid_size

整数,默认值:2

在分页链接中,当前页码两侧的页码显示数量。

prev_next

布尔值,默认值:true

是否显示上一页和下一页。

prev_text

字符串,默认值:« 上一页

上一页的文本。

next_text

字符串,默认值:下一页 »

下一页的文本。

type

字符串,默认值:plain

分页链接的样式。可用值如下:

  • plain:超链接
  • array:数组
  • list:列表

add_args

数组,默认值:false

要添加的查询参数数组。

add_fragment

字符串

要追加到每个链接的字符串。

before_page_number

字符串

出现在页码前的字符串。

after_page_number

字符串

出现在页码后的字符串。

函数使用示例

paginate_comments_links( array(
	'prev_text' => '«',
	'next_text' => '»'
) );

扩展阅读

paginate_comments_links()函数位于:wp-includes/link-template.php

相关函数:

  • paginate_links()
  • get_pagenum_link()
  • get_the_comments_pagination()
Typora