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
| Name | Type(s) | Description |
|---|---|---|
page | Page | Page where comments field exists |
field | Field | Comments field |
comment | Comment | New comment to add |
send | bool | Send comment for automatic approval filtering and email notifications?
|
Return value
boolReturns 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.244