Add a new Permission with the given name and return 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.

Usage

$permission = $permissions->add(string $name);

Arguments

NameType(s)Description
$namestring

Name of permission you want to add, i.e. "hello-world"

Return value

Permission, Page or NullPage

Returns a Permission page on success, or a NullPage on error

Hooking $permissions->add(…)

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

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

$permissions methods and properties

API reference based on ProcessWire core version 3.0.115