paginate_comments_links() 的 $args 参数是一个可选的字符串或数组,用来控制评论分页链接的生成规则。核心参数与 paginate_links() 通用,默认值如下:
-
base:分页 URL 的基础结构,默认add_query_arg( 'cpage', '%#%' )。 -
format:分页结构的格式字符串,默认空。 -
total:总页数,默认由WP_Query的max_num_pages或 1 决定。 -
current:当前页码,默认取自paged查询变量或 1。 -
echo:是否直接输出,默认true;设为false时返回 HTML 字符串。 -
add_fragment:链接后追加的锚点,默认#comments。 -
prev_next:是否显示上一页/下一页链接,默认true。 -
end_size:首尾两端显示的数字个数,默认 1。 -
mid_size:当前页两侧显示的数字个数,默认 2。 -
show_all:是否显示所有页码,默认false。 -
prev_text / next_text:上一页/下一页的文本。 -
type:返回类型,可选plain、array或list。 -
aria_current:aria-current属性的值,默认page。
📌 用法示例
paginate_comments_links( array(
'total' => 5,
'current' => 1,
'prev_next' => false,
'echo' => false,
) );
⚠️ 注意事项
- 函数自 WordPress 2.7.0 起可用,源文件位于
wp-includes/link-template.php。 - 使用前需在后台“设置 → 讨论”中启用评论分页选项。
- 若
echo为true且type不是数组,或当前不是单篇内容页,函数返回void(无输出)。
