InputfieldWrapper::new() method

Create a new Inputfield, add it to this InputfieldWrapper, and return the new Inputfield

  • Only the $typeName argument is required.
  • You may optionally substitute the $settings argument for the $name or $label arguments.
  • You may optionally substitute Inputfield “description” property for $settings argument.

Available since version 3.0.110.

Usage

// basic usage
$inputfield = $inputfieldWrapper->new(string $typeName);

// usage with all arguments
$inputfield = $inputfieldWrapper->new(string $typeName, $name = '', $label = '', $settings = []);

Arguments

NameType(s)Description
typeNamestring

Inputfield type, i.e. “InputfieldCheckbox” or just “checkbox” for short.

name (optional)string, array

Name of input (or substitute $settings here).

label (optional)string, array

Label for input (or substitute $settings here).

settings (optional)array, string

Settings to add to Inputfield (optional). Or if string, assumed to be “description”.

Return value

Inputfield InputfieldSelect InputfieldWrapper

An Inputfield instance ready to populate with additional properties/attributes.

Exceptions

Method can throw exceptions on error:

  • WireException - If you request an unknown Inputfield type


Hooking InputfieldWrapper::new(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $typeName = $event->arguments(0);
  $name = $event->arguments(1);
  $label = $event->arguments(2);
  $settings = $event->arguments(3);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $typeName);
  $event->arguments(1, $name);
  $event->arguments(2, $label);
  $event->arguments(3, $settings);
});

Hooking after

The 'after' hooks are called immediately after each InputfieldWrapper::new(…) 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::new', 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;

  // Get values of arguments sent to hook (if needed)
  $typeName = $event->arguments(0);
  $name = $event->arguments(1);
  $label = $event->arguments(2);
  $settings = $event->arguments(3);

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

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

InputfieldWrapper methods and properties

API reference based on ProcessWire core version 3.0.135

Twitter updates

  • New post: A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email— More
    19 July 2019
  • New post: Version 3.0.135 of ProcessWire on the dev branch focuses on some .htaccess updates, adds clarity to debug mode, and improves upon the installer— More
    5 July 2019
  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019

Latest news

  • ProcessWire Weekly #271
    In the 271st issue of ProcessWire Weekly we're going to introduce two brand new WireMail modules, a new Textformatter module from BitPoet, and a brand new markup module from Chris Thomson. Read on!
    Weekly.pw / 20 July 2019
  • Two new WireMail modules and using Gmail with PW
    A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email.
    Blog / 19 July 2019
  • Subscribe to weekly ProcessWire news

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