FieldtypeFile::wakeupValue() method

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

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

$pagefiles = $fieldtypeFile->wakeupValue(Page $page, Field $field, $value);

Arguments

NameType(s)Description
pagePage
fieldField
valuestring, int, array

Return value

Pagefiles null

$value


Hooking FieldtypeFile::wakeupValue(…)

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

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


FieldtypeFile methods and properties

API reference based on ProcessWire core version 3.0.236

Newest forum posts

    Latest news

    • ProcessWire Weekly #550
      In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
      Weekly.pw / 23 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

    “We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK