CommentArray class

Maintains an array of multiple Comment instances.

Serves as the value referenced when a FieldtypeComment field is reference from a Page.

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

Common

Name	Return	Summary
CommentArray::getCommentForm() CommentArray::getCommentForm() CommentArray::getCommentForm(array $options = [])	`CommentForm`	Return instance of CommentForm object
CommentArray::getCommentList() CommentArray::getCommentList() CommentArray::getCommentList(array $options = [])	`CommentList`	Return instance of CommentList object
CommentArray::getField() CommentArray::getField() CommentArray::getField()	`CommentField` `Field`	Get the Field that these comments are on
CommentArray::getLimit() CommentArray::getLimit() CommentArray::getLimit()	`int`	Get the imposed limit on number of comments.
CommentArray::getPage() CommentArray::getPage() CommentArray::getPage()	`Page`	Get the page that these comments are on
CommentArray::getTotal() CommentArray::getTotal() CommentArray::getTotal()	`int`	Get the total number of comments
CommentArray::hasComment() CommentArray::hasComment($comment) CommentArray::hasComment($comment)	`bool`	Does this CommentArray have the given Comment (or comment ID)?
CommentArray::isIdentical() CommentArray::isIdentical(WireArray $items) CommentArray::isIdentical(WireArray $items, $strict = true)	`bool`	Is the given CommentArray identical to this one?
CommentArray::isValidItem() CommentArray::isValidItem($item) CommentArray::isValidItem($item)	`bool`	Per the WireArray interface, is the item a Comment
CommentArray::makeNew() CommentArray::makeNew() CommentArray::makeNew()	`CommentArray`	Make a new blank CommentArray setup for the same Page/Field as the one it is called on
CommentArray::render() CommentArray::render() CommentArray::render(array $options = [])	`string`	Provides the default rendering of a comment list, which may or may not be what you want
CommentArray::renderAll() CommentArray::renderAll() CommentArray::renderAll(array $options = [])	`string`	Render all comments and a comments form below it
CommentArray::renderForm() CommentArray::renderForm() CommentArray::renderForm(array $options = [])	`string`	Provides the default rendering of a comment form, which may or may not be what you want
CommentArray::renderStars() CommentArray::renderStars() CommentArray::renderStars(bool $showCount = false, array $options = [])	`string`	Render combined star rating for all comments in this CommentsArray
CommentArray::setField() CommentArray::setField($field) CommentArray::setField($field)	None	Set the Field that these comments are on
CommentArray::setPage() CommentArray::setPage(Page $page) CommentArray::setPage(Page $page)	None	Set the page that these comments are on
CommentArray::stars() CommentArray::stars() CommentArray::stars(bool $allowPartial = true, bool $getCount = false)	`int` `float` `false` `array`	Get an average of all star ratings for all comments in this CommentsArray

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.255