Export configuration values for external consumption
Use this method to externalize any config values when necessary. For example, internal IDs should be converted to GUIDs where possible. Most Fieldtype modules can use the default implementation already provided here.
Usage
$array = $fieldtype->exportConfigData(Field $field, array $data);
Arguments
Name | Type(s) | Description |
---|---|---|
field | Field | |
data | array |
Return value
array
Hooking Fieldtype::exportConfigData(…)
You can add your own hook events that are executed either before or after the Fieldtype
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
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('Fieldtype::exportConfigData', 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)
$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 Fieldtype
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::exportConfigData', 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)
$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;
});
Fieldtype methods and properties
API reference based on ProcessWire core version 3.0.236