FieldtypePage::importConfigData() method

Convert an array of exported data to a format that will be understood internally

FieldtypePage: Note the mported config values here are actually from InputfieldPage, but we're handling them in here rather than InputfieldPage::importConfigData() to increase the reusability of these conversions (parent_id and template_id) which are common conversions used by other Fieldtypes.

Usage

$array = $fieldtypePage->importConfigData(Field $field, array $data);

Arguments

Name	Type(s)	Description
`field`	Field
`data`	array

Return value

array

Data as given and modified as needed. Also included is $data[errors], an associative array indexed by property name containing errors that occurred during import of config data.

Hooking FieldtypePage::importConfigData(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $field = $event->arguments(0);
  $data = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $field);
  $event->arguments(1, $data);
});

Hooking after

The 'after' hooks are called immediately after each FieldtypePage::importConfigData(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('FieldtypePage::importConfigData', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypePage = $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);
  $data = $event->arguments(1);

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

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

FieldtypePage methods and properties

API reference based on ProcessWire core version 3.0.244