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

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

显示或检索当前文章评论的分页链接

comment 评论more...

linkmore...

paginate


描述

另见


参数

$args

(string|array) (可选) 参数,见 paginate_links() 的参数

默认值: array()


返回

(void|string|array) 如果“echo”参数为true并且“type”不是数组,或者如果查询不是针对任何文章类型的现有文章单页,则无返回。否则,根据“type”参数,返回评论页面链接的标记或评论页面链接的数组。


说明

默认值

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

传入的参数通过wp_parse_args()合并为默认值
这些参数主要是为了使paginate_links()的调用起作用,因此更改它们时要小心。



源码

查看源码 官方文档


更新日志

版本描述
2.7.0开始引入

使用示例

  • 示例1

    增强的评论显示

    WordPress 使 comments.php 文件易于编写和编辑。很容易将评论分为多个页面,这样你就不会在每个页面视图上加载数百条评论。

    您需要在 设置  > 讨论 中设置选项使分页起效。

    最简单的方法是使用以下函数,它打印出指向下一个和上一个评论页面的链接,以及所有评论页面的页码列表。

    paginate_comments_links( $args );
    

    它接受类似于 get_posts() 或 get_terms() 的数组或查询样式的参数列表。

    如果您想要更多的控制,还可以使用更简单的next和previous函数:

    next_comments_link( $label = "", $max_page = 0 );
    

    previous_comments_link( $label = "" );
    
  • 示例2

    自定义上一个/下一个链接

    要修改上一个和下一个链接,可以使用选项“prev_text”和“next_text”。这些由函数paginate_links()提供。

    paginate_comments_links( array(
    	'prev_text'  => 'back',
    	'next_text' => 'forward'
    ) );
    

    注意:如果要在“prev_text”或“next_text”中使用HTML实体,则必须使用基于数组的语法。

    paginate_comments_links( array(
    	'prev_text' => '«',
    	'next_text' => '»'
    ) )
    
  • 示例3
    paginate_comments_links(array(
    	'screen_reader_text'=> __('Pagination','text_domain'),
    	'prev_text'=> __('Previous','text_domain'),
    	'next_text'=> __('Next','text_domain'),
    ));