FormBuilderProcessor::savePageCheckName() method

Check and update page name as needed for uniqueness (for hooks)

Usage

$bool = $processor->savePageCheckName(Page $page);

Arguments

NameType(s)Description
$pagePage

Return value

bool

Return true on success, or false if save should be aborted


Hooking $processor→savePageCheckName(…)

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

$this->addHookBefore('FormBuilderProcessor::savePageCheckName', 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);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $processor->savePageCheckName(…) 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::savePageCheckName', 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);

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

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

$processor methods and properties

API reference based on ProcessWire core version 3.0.252