FieldtypeMulti::loadPageField() method

Load the given page field from the database table and return the value.

  • 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 = $fieldtypeMulti->loadPageField(Page $page, Field $field);

Arguments

NameType(s)Description
pagePage

Page object to save.

fieldField

Field to retrieve from the page.

Return value

array null


Hooking FieldtypeMulti::loadPageField(…)

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

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

FieldtypeMulti 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

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.