Inputfield::getConfigArray() method

Alternative method for configuration that allows for array definition

Example

// Example implementation
public function ___getConfigArray() {
  return [
    'test' => [
      'type' => 'text',
      'label' => 'This is a test',
      'value' => 'Test'
    ]
  ];
);

Usage

$array = $inputfield->getConfigArray();

Return value

array


Hooking Inputfield::getConfigArray()

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

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

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

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

Inputfield methods and properties

API reference based on ProcessWire core version 3.0.130

Twitter updates

  • New post: ProcessWire 3.0.131 adds support for partial/resumable downloads and http stream delivery, and contains several updates to our comments system, among other updates— More
    3 May 2019
  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019

Latest news

  • ProcessWire Weekly #262
    The 262nd issue of ProcessWire Weekly will cover the latest module updates, both Pro modules and non-commercial ones. We've also got some highlights from the support forum, and a beautiful new site of the week. Read on!
    Weekly.pw / 18 May 2019
  • Lots of module updates
    In this post we take a quick look at the new version of ProFields Repeater Matrix, yet another new version of FormBuilder, and a new version of the GoogleClientAPI module.
    Blog / 17 May 2019
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer