Fieldtype::getFieldSetups()

Get predefined setups for newly created fields of this type

Available since version 3.0.213.

Example

// Example that returns 2 setup options "foo" and "bar"
return array(
  'foo' => array(
    'title' => 'Foo',
    'any_setting' => 'any_value',
    'setup' => function(Field $field) {
       // optional code to setup $field when 'foo' is selected
    }
  ),
  'bar' => array(
    'title' => 'Bar',
    'hello' => 'world', // example of any setting
    'setup' => function(Field $field) {
       // optional code to setup $field when 'bar' is selected
    }
  )
);

Usage

$array = $fieldtype->getFieldSetups();

Return value

array

Hooking Fieldtype::getFieldSetups()

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

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

  /* 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.253