Return an array of configuration field names from that are allowed in fieldgroup/template context

These field names are those that would be used for Inputfields like those returned from getConfigInputfields() or getConfigArray().

Inputfield field names returned from here are allowed to have unique values per Fieldgroup assignment, rather than sharing the same setting globally.

Usage

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

Arguments

NameType(s)Description
$fieldField

Return value

array

of Inputfield names

Hooking Fieldtype::getConfigAllowContext(…)

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

$this->addHookBefore('Fieldtype::getConfigAllowContext', 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::getConfigAllowContext(…) 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::getConfigAllowContext', 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.115