CommentList class

CommentList provides the default implementation of the CommentListInterface interface.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the CommentList class also inherits all the methods and properties of: Wire.

Common

Name	Return	Summary
CommentList::getReplies() CommentList::getReplies($commentID) CommentList::getReplies($commentID)	`array`	Get replies to the given comment ID, or 0 for root level comments
CommentList::options() CommentList::options() CommentList::options($key = null, $value = null)	`array` `string` `int` `bool` `null`	Get or set options
CommentList::placeholders() CommentList::placeholders() CommentList::placeholders($name = '', $value = null)	`string` `array`	Get or set placeholders that will be populated by populatePlaceholders() method
CommentList::render() CommentList::render() CommentList::render()	`string`	Rendering of comments for API demonstration and testing purposes (or feel free to use for production if suitable)
CommentList::renderCheckActions() CommentList::renderCheckActions() CommentList::renderCheckActions(array $options = [])	`string`	Check for URL-based comment approval actions
CommentList::renderItemReady() CommentList::renderItemReady(Comment $comment, $depth) CommentList::renderItemReady(Comment $comment, $depth)	None
CommentList::renderStars() CommentList::renderStars($comment) CommentList::renderStars($comment)	None
CommentList::renderVotes() CommentList::renderVotes($comment) CommentList::renderVotes($comment)	None

Additional methods and properties

In addition to the methods and properties above, CommentList also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.251