Inputfield::getConfigAllowContext() method

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 = $inputfield->getConfigAllowContext(Field $field);

Arguments

NameType(s)Description
fieldField

Return value

array

of Inputfield names


Hooking Inputfield::getConfigAllowContext(…)

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

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

  // 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


Inputfield methods and properties

API reference based on ProcessWire core version 3.0.125

Twitter updates

  • New post: This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new Page if() method— More
    15 February 2019
  • New post: ProcessWire 3.0.125 has several useful new Sanitizer methods & options, plus new ways to access them directly from the Input API variable. This makes handling user input even easier than before. Plus updates to our i18n functions & API docs— More
    25 January 2019
  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019

Latest news

  • ProcessWire Weekly #250
    In the 250th issue of ProcessWire Weekly we'll walk you through some of the latest dev branch updates, take a closer look at PushAlert Notifications and TinyBar modules, and introduce a new site of the week. Read on!
    Weekly.pw / 23 February 2019
  • ProcessWire 3.0.126 core updates
    This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new $page->if() method. 
    Blog / 15 February 2019
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer