FieldtypePage::exportConfigData() method

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.

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

Usage

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

Arguments

NameType(s)Description
fieldField
dataarray

Return value

array


Hooking FieldtypePage::exportConfigData(…)

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

$this->addHookBefore('FieldtypePage::exportConfigData', 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::exportConfigData(…) 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::exportConfigData', 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.236

Latest news

  • ProcessWire Weekly #547
    In the 547th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new modules, and more. Read on!
    Weekly.pw / 2 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani