Given a value originally generated by exportValue() convert it to a live/runtime value.

This is intended for importing from PW-driven web services. If not overridden, it does the same thing as the Fieldtype::wakeupValue() method.

Usage

// basic usage
$string = $fieldtype->importValue(Page $page, Field $field, $value);

// usage with all arguments
$string = $fieldtype->importValue(Page $page, Field $field, $value, array $options = []);

Arguments

NameType(s)Description
$pagePage
$fieldField
$valuestring or int or float or array or null
$options (optional)array

Additional options if needed/applicable

Return value

string, int, array or object

$value

Hooking Fieldtype::importValue(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
  $event->arguments(1, $field);
  $event->arguments(2, $value);
  $event->arguments(3, $options);
});

Hooking after

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

  // Get values of arguments sent to hook (if needed)
  $page = $event->arguments(0);
  $field = $event->arguments(1);
  $value = $event->arguments(2);
  $options = $event->arguments(3);

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