Return a list of config property names allowed for fieldgroup/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 = $inputfieldToggle->getConfigAllowContext(Field $field);Arguments
| Name | Type(s) | Description |
|---|---|---|
field | Field |
Return value
arrayof Inputfield names
Hooking InputfieldToggle::getConfigAllowContext(…)
You can add your own hook events that are executed either before or after the Inputfield 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 method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('InputfieldToggle::getConfigAllowContext', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$InputfieldToggle = $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 Inputfield method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('InputfieldToggle::getConfigAllowContext', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$InputfieldToggle = $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
InputfieldToggle methods and properties
API reference based on ProcessWire core version 3.0.236