FieldtypeComments class

Field that stores user posted comments for a single 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 FieldtypeComments class also inherits all the methods and properties of: FieldtypeMulti, Fieldtype, WireData and Wire.

Common

Name	Return	Summary
FieldtypeComments::addComment() FieldtypeComments::addComment(Page $page, Field $field, Comment $comment, bool $send) FieldtypeComments::addComment(Page $page, Field $field, Comment $comment, bool $send)	`bool`	Add new comment
FieldtypeComments::checkVoteAction() FieldtypeComments::checkVoteAction($page) FieldtypeComments::checkVoteAction($page)	`array`	Check the request for a vote action
FieldtypeComments::count() FieldtypeComments::count($selectorString) FieldtypeComments::count($selectorString, $field = null)	`int`	Given a field and a selector, return total quantity of comments matching the selector
FieldtypeComments::deleteComment() FieldtypeComments::deleteComment(Page $page, Field $field, Comment $comment) FieldtypeComments::deleteComment(Page $page, Field $field, Comment $comment, string $notes = '')	`bool`	Delete a given comment
FieldtypeComments::deleteField() FieldtypeComments::deleteField(Field $field) FieldtypeComments::deleteField(Field $field)	`bool`	Delete the given field, which implies: drop the table $field->table
FieldtypeComments::exportValue() FieldtypeComments::exportValue(Page $page, Field $field, $value) FieldtypeComments::exportValue(Page $page, Field $field, $value, array $options = [])	`array`	Export value
FieldtypeComments::find() FieldtypeComments::find($selectorString) FieldtypeComments::find($selectorString, $field = null, array $options = [])	`CommentArray` `int`	Given a field and a selector, find all comments matching the selector
FieldtypeComments::findComments() FieldtypeComments::findComments($field, string $selectorString) FieldtypeComments::findComments($field, string $selectorString)	`CommentArray`	Find comments, static version for backwards compatibility
FieldtypeComments::getBlankValue() FieldtypeComments::getBlankValue($page, $field) FieldtypeComments::getBlankValue($page, $field)	None
FieldtypeComments::getCommentByCode() FieldtypeComments::getCommentByCode($page, $field, $code) FieldtypeComments::getCommentByCode($page, $field, $code)	`Comment` `null`	Given a comment code or subcode, return the associated comment ID or 0 if it doesn't exist
FieldtypeComments::getCommentByID() FieldtypeComments::getCommentByID($page, $field, int $id) FieldtypeComments::getCommentByID($page, $field, int $id)	`Comment` `null`	Get a comment by ID or NULL if not found
FieldtypeComments::getCommentParents() FieldtypeComments::getCommentParents(Page $page, Field $field, Comment $comment) FieldtypeComments::getCommentParents(Page $page, Field $field, Comment $comment)	`CommentArray`	Get parent comments for given Comment
FieldtypeComments::getCommentsFields() FieldtypeComments::getCommentsFields() FieldtypeComments::getCommentsFields(bool $one = false)	`array` `Field` `null`	Return comments field(s)
FieldtypeComments::getConfigInputfields() FieldtypeComments::getConfigInputfields(Field $field) FieldtypeComments::getConfigInputfields(Field $field)	`InputfieldWrapper`	Configuration that appears with each Comments fieldtype
FieldtypeComments::getDatabaseSchema() FieldtypeComments::getDatabaseSchema(Field $field) FieldtypeComments::getDatabaseSchema(Field $field)	`array`	Schema for the Comments Fieldtype
FieldtypeComments::getFieldClass() FieldtypeComments::getFieldClass() FieldtypeComments::getFieldClass(array $a = [])	None
FieldtypeComments::getInputfield() FieldtypeComments::getInputfield($page, $field) FieldtypeComments::getInputfield($page, $field)	None
FieldtypeComments::getLoadQueryAutojoin() FieldtypeComments::getLoadQueryAutojoin(Field $field, DatabaseQuerySelect $query) FieldtypeComments::getLoadQueryAutojoin(Field $field, DatabaseQuerySelect $query)	`null`	For FieldtypeMulti interface, return NULL to indicate that the field is not auto-joinable
FieldtypeComments::getMatchQuery() FieldtypeComments::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, mixed $value) FieldtypeComments::getMatchQuery(PageFinderDatabaseQuerySelect $query, string $table, string $subfield, string $operator, mixed $value)	`DatabaseQuery` `DatabaseQuerySelect`	Update a query to match the text with a fulltext index
FieldtypeComments::getNotifyEmails() FieldtypeComments::getNotifyEmails(Page $page, Field $field) FieldtypeComments::getNotifyEmails(Page $page, Field $field, $comment = null)	`array`	Get emails (and other data) of people that should be notified for a given Page’s comments
FieldtypeComments::getNumComments() FieldtypeComments::getNumComments(Page $page, Field $field) FieldtypeComments::getNumComments(Page $page, Field $field, array $options = [])	`int`	Get number of comments for Page, optionally limited by specific $options
FieldtypeComments::importValue() FieldtypeComments::importValue(Page $page, Field $field, array $value) FieldtypeComments::importValue(Page $page, Field $field, array $value, array $options = [])	`array` `string`	Import value
FieldtypeComments::sanitizeValue() FieldtypeComments::sanitizeValue($page, $field, $value) FieldtypeComments::sanitizeValue($page, $field, $value)	None
FieldtypeComments::savePageField() FieldtypeComments::savePageField(Page $page, Field $field) FieldtypeComments::savePageField(Page $page, Field $field)	`bool`	Per the Fieldtype interface, Save the given Field from the given Page to the database
FieldtypeComments::sendNotifyEmails() FieldtypeComments::sendNotifyEmails(Page $page, Field $field, Comment $comment, array $emailsData) FieldtypeComments::sendNotifyEmails(Page $page, Field $field, Comment $comment, array $emailsData)	`int`	Get emails (and other data) of people that should be notified for a given Page’s comments
FieldtypeComments::sleepValue() FieldtypeComments::sleepValue(Page $page, Field $field, $value) FieldtypeComments::sleepValue(Page $page, Field $field, $value)	`array`	Given an 'awake' value, as set by wakeupValue, convert the value back to a basic type for storage in DB.
FieldtypeComments::updateComment() FieldtypeComments::updateComment(Page $page, Field $field, Comment $comment, array $properties) FieldtypeComments::updateComment(Page $page, Field $field, Comment $comment, array $properties)	`bool`	Update specific properties for a comment
FieldtypeComments::voteComment() FieldtypeComments::voteComment(Page $page, Field $field, Comment $comment) FieldtypeComments::voteComment(Page $page, Field $field, Comment $comment, bool $up = true)	`bool`	Add a vote to the current comment from the current user/IP
FieldtypeComments::wakeupValue() FieldtypeComments::wakeupValue(Page $page, Field $field, $value) FieldtypeComments::wakeupValue(Page $page, Field $field, $value)	`CommentArray`	Given a raw value (value as stored in DB), return the value as it would appear in a Page object
FieldtypeComments::wired() FieldtypeComments::wired() FieldtypeComments::wired()	None

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
FieldtypeComments::commentAddReady() FieldtypeComments::commentAddReady(Page $page, Field $field, Comment $comment) FieldtypeComments::commentAddReady(Page $page, Field $field, Comment $comment)	None	Hook called when new comment about to be added to DB
FieldtypeComments::commentAdded() FieldtypeComments::commentAdded(Page $page, Field $field, Comment $comment) FieldtypeComments::commentAdded(Page $page, Field $field, Comment $comment)	None	Hook called when new comment has successfully been added to DB
FieldtypeComments::commentApproved() FieldtypeComments::commentApproved(Page $page, Field $field, Comment $comment) FieldtypeComments::commentApproved(Page $page, Field $field, Comment $comment, string $notes = '')	None	Hook called when a comment goes from un-approved to approved
FieldtypeComments::commentDeleted() FieldtypeComments::commentDeleted(Page $page, Field $field, Comment $comment) FieldtypeComments::commentDeleted(Page $page, Field $field, Comment $comment, string $notes = '')	None	Hook called after comment has been deleted
FieldtypeComments::commentUnapproved() FieldtypeComments::commentUnapproved(Page $page, Field $field, Comment $comment) FieldtypeComments::commentUnapproved(Page $page, Field $field, Comment $comment, string $notes = '')	None	Hook called when a comment goes from approved to pending or spam

Deleting

Name	Return	Summary
FieldtypeComments::emptyPageField() FieldtypeComments::emptyPageField(Page $page, Field $field) FieldtypeComments::emptyPageField(Page $page, Field $field)	`bool`	Empty out the DB table data for page field, but leave everything else in tact.

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251