InputfieldWrapper::getConfigInputfields() method

Get configuration Inputfields for this InputfieldWrapper

  • Intended to be extended by each Inputfield as needed to add more config options.

  • The returned InputfieldWrapper ultimately ends up as the "Input" tab in the fields editor (admin).

  • Descending Inputfield classes should first call this method from the parent class to get the default configuration fields and the InputfieldWrapper they can add to.

  • Returned Inputfield instances with a name attribute that starts with an underscore, i.e. "_myname" are assumed to be for runtime use and are NOT stored in the database.

  • If you prefer, you may instead implement the Inputfield::getConfigArray() method as an alternative.

Example

// Example getConfigInputfields() implementation
public function ___getConfigInputfields() {
  // Get the defaults and $inputfields wrapper we can add to
  $inputfields = parent::___getConfigInputfields();
  // Add a new Inputfield to it
  $f = $this->wire('modules')->get('InputfieldText');
  $f->attr('name', 'first_name');
  $f->attr('value', $this->get('first_name'));
  $f->label = 'Your First Name';
  $inputfields->add($f);
  return $inputfields;
}

Usage

$inputfieldWrapper = $inputfieldWrapper->getConfigInputfields();

Return value

InputfieldWrapper

Populated with Inputfield instances


Hooking InputfieldWrapper::getConfigInputfields()

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

$this->addHookBefore('InputfieldWrapper::getConfigInputfields', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $InputfieldWrapper = $event->object;

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

The 'after' hooks are called immediately after each InputfieldWrapper::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('InputfieldWrapper::getConfigInputfields', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $InputfieldWrapper = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

See Also


InputfieldWrapper methods and properties

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • New post: An introductory look at ProcessWire LoginRegisterPro, a module for providing new user registration, secure logins, profile editing, and more— More
    13 December 2019
  • ProcessWire 3.0.146 on the dev branch contains about 22 commits with a combination of useful upgrades and issue report resolutions, more details in this forum post: More
    22 November 2019
  • ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core. More
    8 November 2019

Latest news

  • ProcessWire Weekly #291
    In the 291st issue of ProcessWire Weekly we're going to take a closer look at the latest core updates, check out a brand new third party module called ProcessHelpVideos, and introduce a new site of the week. Read on!
    Weekly.pw / 8 December 2019
  • Login Register Pro
    This week we’ll take a look at LoginRegisterPro — a new module that provides an all-in-one, self contained module for providing new user registration, secure logins, profile editing, and more. It does this all in a manner that is reliable, efficient, comprehensive and secure.
    Blog / 13 December 2019
  • 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