FieldtypeModule::getConfigInputfields() method

Configure field

This is in addition to any configuration fields supplied by the Inputfield.

Classes implementing this method should call upon this parent method to obtain the InputfieldWrapper, and then append their own Inputfields to that.

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 = $fieldtypeModule->getConfigInputfields(Field $field);

Arguments

Name	Type(s)	Description
`field`	Field

Return value

InputfieldWrapper

Hooking FieldtypeModule::getConfigInputfields(…)

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

$this->addHookBefore('FieldtypeModule::getConfigInputfields', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypeModule = $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 FieldtypeModule::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('FieldtypeModule::getConfigInputfields', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypeModule = $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;
});

FieldtypeModule methods and properties

API reference based on ProcessWire core version 3.0.236