FieldtypePageTable::wakeupValue() method

Wake up a stored 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

$items = $fieldtypePageTable->wakeupValue(Page $page, $field, array $value);

Arguments

NameType(s)Description
pagePage
fieldField, PageTableField
valuearray

Return value

PageArray

$value


Hooking FieldtypePageTable::wakeupValue(…)

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

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


FieldtypePageTable methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • 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