FieldtypeRepeater::wakeupValue() method

Given a raw value (value as stored in DB), return the value as it would appear in a Page object

Something to note is that this wakeup function is different than most in that the $value it is given is just an array like array('data' => 123, 'parent_id' => 456) -- it doesn't actually contain any of the repeater page data other than saying how many there are and the parent where they are stored. So this wakeup function can technically do it's job without even having the $value, unlike most other fieldtypes.

Usage

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

Arguments

NameType(s)Description
pagePage
fieldField
valuearray

Return value

PageArray

$value


Hooking FieldtypeRepeater::wakeupValue(…)

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

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


FieldtypeRepeater methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #542
    In the 542nd issue of ProcessWire Weekly we'll check out a couple of new third party modules, a new site of the week, and more. Read on!
    Weekly.pw / 28 September 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

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer