wp_list_comments 函数是一个循环输出当前文章或页面每个评论的函数,在 WordPress 主题中主要被用来输出每一条评论,省去我们手工便利之苦,也把 WordPress 的评论功能很好的进行了模块化。
wp_list_comments函数在主题中配合comments_template函数联合使用可以很好的将 WordPress 的评论功能独立出来,而且可以更好对评论嵌套层数、每页显示评论数量、评论样式等等等等进行控制。所以如果你想做好主题的话,那还是看一下吧。
描述
英文原文:
Displays all comments for a post or Page based on a variety of parameters including ones set in the administration area.
我的理解:
用一个整体设置的参数来显示一篇文章、页面的所有评论。
用法
<?php wp_list_comments( $args ); ?> |
参数使用
<?php $args = array( 'walker' => null, 'max_depth' => , 'style' => 'ul', 'callback' => null, 'end-callback' => null, 'type' => 'all', 'page' => , 'per_page' => , 'avatar_size' => 32, 'reverse_top_level' => null, 'reverse_children' => ); ?> |
- $walker 自定义样式类名
- $avatar_size 头像大小 Default: 32
- $style 评论容器标签可以是 ‘div’, ‘ol’, or ‘ul’,默认值是’ul’,如果不是,那你需要像如下那样明确写出。
<div><?php wp_list_comments(array('style' => 'div')); ?></div>
或
<ol><?php wp_list_comments(array('style' => 'ol')); ?></ol>
- $type 显示何种评论,参数可以是 ‘all’、’comment’、’trackback’、’pingback’、’pings’. ‘pings’ 包括’trackback’ 和 ‘pingback’.
默认值: ‘all’ - $reply_text 回复按钮的文本值,这个较少用不解释 默认值: ‘Reply’
- $login_text 登录按钮的文本值,这个较少用不解释 默认值: ‘Log in to Reply’
- $callback 评论显示的回调函数,即显示评论主题的函数名称
- $end-callback 应该是循环结束后的回调函数,本人未实测,请自行探索。
- $reverse_top_level 布尔值,如果设置本参数为真,则先显示最新一条评论,后面的评论按照后台设置显示。
- $reverse_children 布尔值,如果设置本参数为真,则先显示最新一条有子评论的评论,后面的评论按照后台设置显示。
实例
这里是官方默认主题 twentyeleven 中的评论显示演示,
具体其他的参数请参照以上介绍自行演示探索。
<ol> <?php /* Loop through and list the comments. Tell wp_list_comments() * to use twentyeleven_comment() to format the comments. * If you want to overload this in a child theme then you can * define twentyeleven_comment() and that will be used instead. * See twentyeleven_comment() in twentyeleven/functions.php for more. */ wp_list_comments( array( 'callback' => 'twentyeleven_comment' ) ); //twentyeleven_comment 函数在主题文件 "twentyeleven/functions.php"中定义。 ?> </ol> |
总结
在早期的主题中,wp_list_comments 函数我们不常看到,
该函数是从 WordPress 2.7.0 版本后才出现的,
相较于之前的获取评论对象,再进行遍历的方法,
简单的用一个函数做成类似于主循环的效果,对于主题作者来说还是很方便的。
比如说之前提到的@悬浮显示评论内容功能详解,
跨页显示评论功能就是依托本函数的模块化精神来实现的。
好了,是否有一种迫不及待的感觉?
那就开始吧!
函数官方文档地址(英文):
http://codex.wordpress.org/Function_Reference/wp_list_comments
其他中文文献:无。