CommentField class

Custom “Field” class for Comments fields.

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

Common
Properties

Common

Name	Return	Summary
CommentField::addComment() CommentField::addComment(Page $page, Comment $comment, bool $send) CommentField::addComment(Page $page, Comment $comment, bool $send)	`bool`	Add new comment
CommentField::allowCommentPage() CommentField::allowCommentPage(Comment $comment, Page $page) CommentField::allowCommentPage(Comment $comment, Page $page, bool $verbose = false)	`bool`	Allow given comment to live on given page?
CommentField::allowCommentParent() CommentField::allowCommentParent(Comment $comment, $parent) CommentField::allowCommentParent(Comment $comment, $parent, bool $verbose = false)	`bool`	Allow given Comment to have given parent comment?
CommentField::allowDeleteComment() CommentField::allowDeleteComment(Comment $comment) CommentField::allowDeleteComment(Comment $comment)	`bool`	May the given comment be deleted?
CommentField::count() CommentField::count($selectorString) CommentField::count($selectorString)	`int`	Return total quantity of comments matching the selector
CommentField::deleteComment() CommentField::deleteComment(Page $page, Comment $comment) CommentField::deleteComment(Page $page, Comment $comment, string $notes = '')	`mixed`	Delete a given comment
CommentField::find() CommentField::find($selectorString) CommentField::find($selectorString, array $options = [])	`CommentArray`	Find comments matching given selector
CommentField::getCommentByCode() CommentField::getCommentByCode($page, string $code) CommentField::getCommentByCode($page, string $code)	`Comment` `null`	Given a comment code or subcode, return the associated comment ID or 0 if it doesn't exist
CommentField::getCommentByID() CommentField::getCommentByID($page, int $id) CommentField::getCommentByID($page, int $id)	`Comment` `null`	Get a comment by ID or NULL if not found
CommentField::getCommentParents() CommentField::getCommentParents(Page $page, Comment $comment) CommentField::getCommentParents(Page $page, Comment $comment)	`CommentArray`	Get parent comments for given Comment
CommentField::getCommentsByID() CommentField::getCommentsByID(array $ids) CommentField::getCommentsByID(array $ids, $page = null)	`CommentArray`	Get multiple comments by ID
CommentField::getFieldtype() CommentField::getFieldtype() CommentField::getFieldtype()	`FieldtypeComments` `Fieldtype`	@return FieldtypeComments\|Fieldtype
CommentField::getNumComments() CommentField::getNumComments(Page $page) CommentField::getNumComments(Page $page, array $options = [])	`int`	Get number of comments for Page, optionally limited by specific $options
CommentField::updateComment() CommentField::updateComment(Page $page, Comment $comment, array $properties) CommentField::updateComment(Page $page, Comment $comment, array $properties)	`bool`	Update specific properties for a comment
CommentField::voteComment() CommentField::voteComment(Page $page, Comment $comment) CommentField::voteComment(Page $page, Comment $comment, bool $up = true)	`bool`	Add a vote to the current comment from the current user/IP

Properties

Name	Return	Summary
CommentField::dateFormat	`string`
CommentField::deleteSpamDays	`int`
CommentField::depth	`int`
CommentField::fromEmail	`string`
CommentField::moderate	`int`
CommentField::notificationEmail	`string`
CommentField::notifySpam	`int`
CommentField::quietSave	`int` `bool`
CommentField::redirectAfterPost	`int` `bool`
CommentField::schemaVersion	`int`
CommentField::sortNewest	`int` `bool`
CommentField::useAkismet	`int` `bool`
CommentField::useGravatar	`string`
CommentField::useNotify	`int`	See Comment::flagNotify* constants
CommentField::useNotifyText	`bool` `int`	Include comment text in notification emails?
CommentField::useStars	`int`
CommentField::useVotes	`int`
CommentField::useWebsite	`int` `bool`

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.255