FieldtypeComments::addComment()

Add new comment

Requires a new Comment object with no id, that has all its required field populated and validated and is ready to add. Note that the sort property is assigned automatically if not specified in Comment.

The primary reason to use this method is if you want to add a comment without loading all the other comments on a given Page.

Note: if you are hooking this method, comments can also be added by the savePageField method

Available since version 3.0.153.

Usage

$bool = $fieldtypeComments->addComment(Page $page, Field $field, Comment $comment, bool $send);

Arguments

NameType(s)Description
$pagePage

Page where comments field exists

$fieldField

Comments field

$commentComment

New comment to add

$sendbool

Send comment for automatic approval filtering and email notifications?

  • true if comment was just submitted now from user input and filtering should apply, notifications sent, etc.
  • false if you are importing comments and NO filtering should be applied, NO notifications sent, etc.

Return value

bool

Returns true on success, false on fail

Exceptions

Method can throw exceptions on error:

  • WireException - if given a Comment object that is not ready to add


FieldtypeComments methods and properties

API reference based on ProcessWire core version 3.0.251