Fieldtype::getConfigInputfields() method

Get any Inputfields used for configuration of this Fieldtype.

This is in addition to any configuration fields supplied by the Inputfield.

Classes implementing this method should call upon this parent method to obtain the InputfieldWrapper, and then append their own Inputfields to that.

NOTE: Inputfields with a name that starts with an underscore, i.e. "_myname" are assumed to be for runtime use and are NOT stored in the database.

Usage

$inputfieldWrapper = $fieldtype->getConfigInputfields(Field $field);

Arguments

NameType(s)Description
fieldField

Return value


Hooking Fieldtype::getConfigInputfields(…)

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

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

Twitter updates

  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020
  • If you haven't seen it yet, be sure to check out this great infographic by @teppokoivula in ProcessWire Weekly #294— How ProcessWire professionals work—the results of our recent weekly polls summarised: weekly.pw/issue/294/#how…
    3 January 2020
  • Today we have a new master version released, 3.0.148! There are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we take a closer look at what’s new, how to upgrade, & more— More
    3 January 2020

Latest news

  • ProcessWire Weekly #296
    In the 296th issue of ProcessWire Weekly we're going to introduce the newly released front-end file uploads support for LoginRegisterPro, introduce a couple of third party modules, and more. Read on!
    Weekly.pw / 11 January 2020
  • ProcessWire 3.0.148 new master
    Today we have a new master version released, version 3.0.148! The last master version was 3.0.123, so there are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we’ll take a closer look at what’s new, how to upgrade, and more.
    Blog / 3 January 2020
  • Subscribe to weekly ProcessWire news

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