FieldtypeComments::getConfigInputfields() method

Configuration that appears with each Comments fieldtype

Inputfields returned from this appear under the "Advanced" tab rather than the "Details" tab, in the Field editor.

In most cases, you will want to implement the getConfigInputfields() or getConfigArray() rather than this method.

NOTE: Inputfields with a name that starts with an underscore, i.e. "_myname" are assumed to be for runtime use and are NOT stored in the database.

Usage

$inputfieldWrapper = $fieldtypeComments->getConfigInputfields(Field $field);

Arguments

Name	Type(s)	Description
`field`	Field

Return value

InputfieldWrapper

Hooking FieldtypeComments::getConfigInputfields(…)

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

$this->addHookBefore('FieldtypeComments::getConfigInputfields', 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)
  $field = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $field);
});

Hooking after

The 'after' hooks are called immediately after each FieldtypeComments::getConfigInputfields(…) 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::getConfigInputfields', 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)
  $field = $event->arguments(0);

  /* 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