$fields→new()

Create and save a new Field of the given type

Available since version 3.0.258.

Example

// Creating a new text field
$field = $fields->new('text', 'my_text_field', 'My Text Field');

// Creating a new textarea field (demonstrates options)
$field = $fields->new('textarea', 'body', [
  'label' => 'Body',
  'textformatters' => [ 'TextformatterEntities' ]
]);

Usage

// basic usage
$field = $fields->new($type);

// usage with all arguments
$field = $fields->new($type, string $name = '', $options = []);

Arguments

Name	Type(s)	Description
`$type`	`string` `array`	Fieldtype class name: 'FieldtypeText', 'Text', or 'text' all accepted, or array containing 'type' and 'name' and anything else that would usually go in $options
`$name` (optional)	`string`	Field name (required)
`$options` (optional)	`string` `array`	Field label or `[key=>val]` array of properties to set to Field (optional)

Return value

Field

Exceptions

Method can throw exceptions on error:

WireException - if the fieldtype is not found or field cannot be saved

Hooking $fields→new(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $type);
  $event->arguments(1, $name);
  $event->arguments(2, $options);
});

Hooking after

The 'after' hooks are called immediately after each $fields->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('Fields::new', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $fields = $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)
  $type = $event->arguments(0);
  $name = $event->arguments(1);
  $options = $event->arguments(2);

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

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

$fields methods and properties

API reference based on ProcessWire core version 3.0.259