FormBuilderProcessor::savePageFileField() method

Save an individual files field to a Page

Available since version 0.4.7.

Usage

$int = $formBuilderProcessor->savePageFileField(Page $page, Field $field, array $filenames, string $formFieldName);

Arguments

NameType(s)Description
pagePage

Page that has files field

fieldField

ProcessWire field instance representing files field

filenamesarray

Names of files to add (full paths included)

formFieldNamestring

Name of the form field being saved

Return value

int

Number of files added


Hooking FormBuilderProcessor::savePageFileField(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);
  $field = $event->arguments(1);
  $filenames = $event->arguments(2);
  $formFieldName = $event->arguments(3);

  /* 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, $filenames);
  $event->arguments(3, $formFieldName);
});

Hooking after

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

$this->addHookAfter('FormBuilderProcessor::savePageFileField', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FormBuilderProcessor = $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);
  $filenames = $event->arguments(2);
  $formFieldName = $event->arguments(3);

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

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

FormBuilderProcessor methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #523
    In the 523rd issue of ProcessWire Weekly we'll check out what's new in the core this week, share some new module related news, and more. Read on!
    Weekly.pw / 18 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer