InputfieldTextarea::getConfigAllowContext() method

Get config fields allowed for 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 = $inputfieldTextarea->getConfigAllowContext(Field $field);

Arguments

NameType(s)Description
fieldField

Return value

array

of Inputfield names


Hooking InputfieldTextarea::getConfigAllowContext(…)

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

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


InputfieldTextarea methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #553
    In the 553rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called Text Synthesis, and more. Read on!
    Weekly.pw / 14 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK