Fieldtype::getConfigArray() method

Same as getConfigInputfields but with definition as an array instead

If both getConfigInputfields and getConfigInputfieldsArray are implemented then definitions from both will be used. It's probably simplest just to implement one or the other.

Usage

$array = $fieldtype->getConfigArray(Field $field);

Arguments

NameType(s)Description
fieldField

Return value

array


Hooking Fieldtype::getConfigArray(…)

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

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

Fieldtype methods and properties

API reference based on ProcessWire core version 3.0.228

Latest news

  • ProcessWire Weekly #499
    In the 499th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called RockPdf, and more. Read on!
    Weekly.pw / 3 December 2023
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 2023
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer