$pages→setupPageName()

Auto-assign a page name to the given page

Typically this would be used only if page had no name or if it had a temporary untitled name.

Page will be populated with the name given. This method will not populate names to pages that already have a name, unless the name is "untitled"

Usage

// basic usage
$string = $pages->setupPageName(Page $page);

// usage with all arguments
$string = $pages->setupPageName(Page $page, array $options = []);

Arguments

Name	Type(s)	Description
`$page`	`Page`
`$options` (optional)	`array`	format: Optionally specify the format to use, or leave blank to auto-determine.

Return value

string

If a name was generated it is returned. If no name was generated blank is returned.

Hooking $pages→setupPageName(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $pages->setupPageName(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Pages::setupPageName', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $pages = $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);
  $options = $event->arguments(1);

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

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

$pages methods and properties

API reference based on ProcessWire core version 3.0.251