FieldtypeComments::importValue() method

Import value

Note: importValue does not delete comments, only insert or update.

Usage

// basic usage
$array = $fieldtypeComments->importValue(Page $page, Field $field, array $value);

// usage with all arguments
$array = $fieldtypeComments->importValue(Page $page, Field $field, array $value, array $options = []);

Arguments

Name	Type(s)	Description
`page`	Page
`field`	Field
`value`	array
`options` (optional)	array

Return value

array string

Hooking FieldtypeComments::importValue(…)

You can add your own hook events that are executed either before or after the FieldtypeComments::importValue(…) 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::importValue(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('FieldtypeComments::importValue', 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);
  $value = $event->arguments(2);
  $options = $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, $value);
  $event->arguments(3, $options);
});

Hooking after

The 'after' hooks are called immediately after each FieldtypeComments::importValue(…) 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::importValue', 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);
  $value = $event->arguments(2);
  $options = $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