FieldtypeRepeater::savePageField() method

Save the given field from page

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

Usage

$bool = $fieldtypeRepeater->savePageField(Page $page, Field $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 FieldtypeRepeater::savePageField(…)

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

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

FieldtypeRepeater methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #533
    In the 533rd issue of ProcessWire Weekly we'll check out some newly released third party modules and highlight a new site of the week. Read on!
    Weekly.pw / 27 July 2024
  • Page List Custom Children module
    This simple module gives you the ability to customize the parent/child relationship as it appears in the admin page list, enabling child pages to appear under more than one parent.
    Blog / 28 June 2024
  • Subscribe to weekly ProcessWire news

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