Inputfield::getConfigArray() method

Alternative method for configuration that allows for array definition

This method is typically used instead of the Inputfield::getConfigInputfields method for module authors that prefer to use the array definition.
If both getConfigInputfields() and getConfigArray() are implemented, both will be used.
See comments for InputfieldWrapper::importArray() for example of array definition.

Example

// Example implementation
public function ___getConfigArray() {
  return [
    'test' => [
      'type' => 'text',
      'label' => 'This is a test',
      'value' => 'Test'
    ]
  ];
);

Usage

$array = $inputfield->getConfigArray();

Return value

array

Hooking Inputfield::getConfigArray()

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

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

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

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

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

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

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

Inputfield methods and properties

API reference based on ProcessWire core version 3.0.236