ProcessPageEditLink::getFilesPage()

Get array of info about files attached to given Page, including any repeater items

Hookable in 3.0.222+ only

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

Internal usage

// basic internal usage
$array = $processPageEditLink->getFilesPage(Page $page);

// internal usage with all arguments
$array = $processPageEditLink->getFilesPage(Page $page, string $prefix = '');

Arguments

NameType(s)Description
$pagePage
$prefix (optional)string

Optional prefix to prepend to "Field label:" portion of label

Return value

array

Associative array of "/url/to/file.pdf" => "Field label: basename"


Hooking ProcessPageEditLink::getFilesPage(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

ProcessPageEditLink methods and properties

API reference based on ProcessWire core version 3.0.251