FieldtypeFieldsetOpen::savePageField() method

Save the given field from given page to the database.

Possible template method: If overridden, it is likely not necessary to call this parent method.

Usage

$fieldtypeFieldsetOpen->savePageField($page, $field);

Arguments

NameType(s)Description
pagePage

Page object to save.

fieldField

Field to retrieve from the page.

Return value

bool

True on success, false on DB save failure.

Exceptions

Method can throw exceptions on error:

  • WireException or \PDOException or WireDatabaseException


Hooking FieldtypeFieldsetOpen::savePageField(…)

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

$this->addHookBefore('FieldtypeFieldsetOpen::savePageField', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypeFieldsetOpen = $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 FieldtypeFieldsetOpen::savePageField(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

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

FieldtypeFieldsetOpen methods and properties

API reference based on ProcessWire core version 3.0.244

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits