FormBuilderProcessor::savePage() method

Save the form entry to a Page

If saving an existing page, the ID of that page will be in $data['_savePage']
If $status omitted or null, it is determined automatically from form settings (most common call).
If $onlyFields is an array, only the field names specified will be saved.

Usage

// basic usage
$page = $formBuilderProcessor->savePage(array $data);

// usage with all arguments
$page = $formBuilderProcessor->savePage(array $data, int $status = null, $onlyFields = null);

Arguments

Name	Type(s)	Description
`data`	array	Form data to send to page
`status` (optional)	int	Status of created pages
`onlyFields` (optional)	array, null	Save field names present in this array. If omitted, save all field names. Names are form field names.

Return value

Page null

Created page or null on failure

Hooking FormBuilderProcessor::savePage(…)

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

$this->addHookBefore('FormBuilderProcessor::savePage', 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)
  $data = $event->arguments(0);
  $status = $event->arguments(1);
  $onlyFields = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $data);
  $event->arguments(1, $status);
  $event->arguments(2, $onlyFields);
});

Hooking after

The 'after' hooks are called immediately after each FormBuilderProcessor::savePage(…) 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::savePage', 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)
  $data = $event->arguments(0);
  $status = $event->arguments(1);
  $onlyFields = $event->arguments(2);

  /* 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