FieldtypeComments::updateComment() method

Update specific properties for a comment

Usage

$bool = $fieldtypeComments->updateComment(Page $page, Field $field, Comment $comment, array $properties);

Arguments

NameType(s)Description
pagePage
fieldField
commentComment
propertiesarray

Associative array of properties to update

Return value

bool

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking FieldtypeComments::updateComment(…)

You can add your own hook events that are executed either before or after the FieldtypeComments::updateComment(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each FieldtypeComments::updateComment(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('FieldtypeComments::updateComment', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypeComments = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);
  $field = $event->arguments(1);
  $comment = $event->arguments(2);
  $properties = $event->arguments(3);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
  $event->arguments(1, $field);
  $event->arguments(2, $comment);
  $event->arguments(3, $properties);
});

Hooking after

The 'after' hooks are called immediately after each FieldtypeComments::updateComment(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('FieldtypeComments::updateComment', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypeComments = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $page = $event->arguments(0);
  $field = $event->arguments(1);
  $comment = $event->arguments(2);
  $properties = $event->arguments(3);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

FieldtypeComments methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #547
    In the 547th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new modules, and more. Read on!
    Weekly.pw / 2 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH