$users->add() method

Adds a new page with the given $name and returns it

If the page has any other fields, they will not be populated, only the name will.
Returns a NullPage on error, such as when a page of this type already exists with the same name/parent.

Hook note: If you want to hook this method, please hook the addReady, Pages::add, or Pages::addReady method instead, as hooking this method will not hook relevant pages added directly through $pages->add().

Usage

$page = $users->add(string $name);

Arguments

Name	Type(s)	Description
`name`	string	Name to use for the new page

Return value

Page NullPage

Hooking $users->add(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('Users::add', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $users = $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)
  $name = $event->arguments(0);

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

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

$users methods and properties

API reference based on ProcessWire core version 3.0.244