FieldtypeEmail::getConfigAdvancedInputfields() method

Advanced configuration for field

Inputfields returned from this appear under the "Advanced" tab rather than the "Details" tab, in the Field editor.

In most cases, you will want to implement the getConfigInputfields() or getConfigArray() rather than this method.

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 = $fieldtypeEmail->getConfigAdvancedInputfields(Field $field);

Arguments

NameType(s)Description
fieldField

Return value


Hooking FieldtypeEmail::getConfigAdvancedInputfields(…)

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

$this->addHookBefore('FieldtypeEmail::getConfigAdvancedInputfields', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypeEmail = $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 FieldtypeEmail::getConfigAdvancedInputfields(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

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

FieldtypeEmail methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull