WireSaveableItems::load()

Load items from the database table and return them in the same type class that getAll() returns

A selector string or Selectors may be provided so that this can be used as a find() by descending classes that don't load all items at once.

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Internal usage

// basic internal usage
$items = $wireSaveableItems->load(WireArray $items);

// internal usage with all arguments
$items = $wireSaveableItems->load(WireArray $items, $selectors = null);

Arguments

Name	Type(s)	Description
`$items`	`WireArray`
`$selectors` (optional)	`Selectors` `string` `null`	Selectors or a selector string to find, or NULL to load all.

Return value

WireArray

Returns the same type as specified in the getAll() method.

Hooking WireSaveableItems::load(…)

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

$this->addHookBefore('WireSaveableItems::load', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireSaveableItems = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $items = $event->arguments(0);
  $selectors = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each WireSaveableItems::load(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('WireSaveableItems::load', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireSaveableItems = $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)
  $items = $event->arguments(0);
  $selectors = $event->arguments(1);

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

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

WireSaveableItems methods and properties

API reference based on ProcessWire core version 3.0.251