$process->userNotAllowed() method

Called when a 401 unauthorized or 403 forbidden request

Available since version 3.0.186.

Usage

$process->userNotAllowed(User $user, $page, PagesRequest $request);

Arguments

NameType(s)Description
userUser
pagePage, NullPage, null
requestPagesRequest

Hooking $process->userNotAllowed(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('ProcessPageView::userNotAllowed', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $process = $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)
  $user = $event->arguments(0);
  $page = $event->arguments(1);
  $request = $event->arguments(2);

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

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

$process methods and properties

API reference based on ProcessWire core version 3.0.244

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull