FieldtypeModule::wakeupValue() method

Wakeup value

In many cases, no change to the value may be necessary, but if a Page expects this value as an object (for instance) then this would be the method that converts that value to an object and returns it.

This method is called by the Page class, which takes the value provided by Fieldtype::loadPageField() and sends it to this method before making it a part of the Page.

Usage

$string = $fieldtypeModule->wakeupValue(Page $page, Field $field, $value);

Arguments

NameType(s)Description
pagePage
fieldField
valuearray, int, string

Return value

string

$value


Hooking FieldtypeModule::wakeupValue(…)

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

$this->addHookBefore('FieldtypeModule::wakeupValue', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypeModule = $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);

  /* 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);
});

Hooking after

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

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

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

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

See Also


FieldtypeModule methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #581
    The 581st issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 28 June 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH