comment_text()
云策文档标注
概述
comment_text() 函数用于显示当前评论的文本内容。它通过获取评论对象并应用过滤器来输出评论文本，适用于在主题或插件中展示评论。
关键要点
- 函数接受两个可选参数：$comment_id（评论ID或WP_Comment对象，默认为当前评论）和$args（参数数组，默认为空数组）。
- 内部调用 get_comment() 和 get_comment_text() 来获取评论文本，并通过 apply_filters('comment_text', ...) 应用过滤器。
- 与 Walker_Comment 类相关，用于在评论列表或HTML5格式中输出评论。
- 自WordPress 4.4.0起，$comment_id 参数支持WP_Comment对象。
代码示例
<?php comment_text(); ?>注意事项
- 确保在评论循环内调用此函数以正确获取当前评论。
- 可通过过滤器 'comment_text' 自定义输出文本。
原文内容
Displays the text of the current comment.
Description
See also
Parameters
$comment_idint|WP_Commentoptional-
WP_Comment or ID of the comment for which to print the text.
Default current comment. $argsarrayoptional-
An array of arguments.
Default:
array()
Source
function comment_text( $comment_id = 0, $args = array() ) {
$comment = get_comment( $comment_id );
$comment_text = get_comment_text( $comment, $args );
/**
* Filters the text of a comment to be displayed.
*
* @since 1.2.0
*
* @see Walker_Comment::comment()
*
* @param string $comment_text Text of the comment.
* @param WP_Comment|null $comment The comment object. Null if not found.
* @param array $args An array of arguments.
*/
echo apply_filters( 'comment_text', $comment_text, $comment, $args );
}
Hooks
- apply_filters( ‘comment_text’, string $comment_text, WP_Comment|null $comment, array $args )
-
Filters the text of a comment to be displayed.
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Added the ability for $comment_id to also accept a WP_Comment object. |
| 0.71 | Introduced. |
Skip to note 2 content
Codex
Basic Example
Displays the comment text with the comment author in a list (
) tag.<ul> <li> <br /> </li> </ul>