InputfieldText::getConfigAllowContext() method

Get array of field names allowed for field/template context

These should be the names of Inputfields returned by Inputfield::getConfigInputfields() or Inputfield::getConfigArray() that are allowed in fieldgroup/template context.

The config property names specified here are allowed to be configured within the context of a given Fieldgroup, enabling the user to configure them independently per template in the admin.

This is the equivalent to the [Fieldtype::getConfigAllowContext()](/api/ref/fieldtype/get-config-allow-conFieldtype::getConfigAllowContext()/) method, but for the "Input" tab rather than the "Details" tab.

Usage

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

Arguments

NameType(s)Description
fieldField

Return value

array

of Inputfield names


Hooking InputfieldText::getConfigAllowContext(…)

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

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

See Also


InputfieldText methods and properties

API reference based on ProcessWire core version 3.0.244

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits