Generates a user input form for comments, processes comment input, and saves to the 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 CommentForm class also inherits all the methods and properties of: Wire.
Common
| Name | Return | Summary | |
|---|
CommentForm::attrs() CommentForm::attrs(string $name) CommentForm::attrs(string $name, $value = null) | string | Get or set attribute | |
CommentForm::classes() CommentForm::classes(string $name) CommentForm::classes(string $name, $value = null) | string | Get or set class(es) | |
CommentForm::getOptions() CommentForm::getOptions() CommentForm::getOptions() | array | Get options | |
| None | Return the Comment that was posted or NULL if not yet posted | |
CommentForm::labels() CommentForm::labels(string $name) CommentForm::labels(string $name, $value = null) | string | Get or set label | |
CommentForm::markup() CommentForm::markup(string $name) CommentForm::markup(string $name, $value = null) | string | Get or set markup | |
CommentForm::option() CommentForm::option($key) CommentForm::option($key, $value = null) | None | | |
CommentForm::presets() CommentForm::presets(string $name) CommentForm::presets(string $name, $value = null) | string | Get or set presets | |
CommentForm::processInput() CommentForm::processInput() CommentForm::processInput() | Comment bool | Process a submitted CommentForm, insert the Comment, and save the Page | |
CommentForm::render() CommentForm::render() CommentForm::render() | string | Render the CommentForm output and process the input if it's been submitted | |
CommentForm::setAttr() CommentForm::setAttr(string $attr, string $value) CommentForm::setAttr(string $attr, string $value) | None | Set attribute | |
CommentForm::setLabel() CommentForm::setLabel(string $label, string $value) CommentForm::setLabel(string $label, string $value) | None | Set label | |
CommentForm::setOptions() CommentForm::setOptions(array $options) CommentForm::setOptions(array $options) | None | Initialize and set options | |
Additional methods and properties
In addition to the methods and properties above, CommentForm also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.251