FieldtypeFile::loadPageField() method

@param Page $page

Return NULL if the value is not available, or array when it is.
Return the value as it exists in the database (as an array), without further processing.
This is intended only to be called by Page objects on an as-needed basis.
Typically this is only called for fields that don't have 'autojoin' turned on.
Any actual conversion of the value should be handled by the Fieldtype::wakeupValue() method.

If pagination is active, the following extra properties are populated to the returned array value:

_pagination_limit (int): The specified limit of items per pagination.
_pagination_start (int): The starting index of the pagination.
_pagination_total (int): The total number of items across all paginations.

Usage

$array = $fieldtypeFile->loadPageField(Page $page, Field $field);

Arguments

Name	Type(s)	Description
`page`	Page	Page object to save.
`field`	Field	Field to retrieve from the page.

Return value

array null

Hooking FieldtypeFile::loadPageField(…)

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

$this->addHookBefore('FieldtypeFile::loadPageField', 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);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
  $event->arguments(1, $field);
});

Hooking after

The 'after' hooks are called immediately after each FieldtypeFile::loadPageField(…) 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::loadPageField', 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);

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

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

FieldtypeFile methods and properties

API reference based on ProcessWire core version 3.0.236