PagesRequest::getLoginPageOrUrl() method

Get login Page object or URL to redirect to for login needed to access given $page

When a Page is returned, it is suggested the Page be rendered in this request.
When a string/URL is returned, it is suggested you redirect to it.
When null is returned no login page or URL could be identified and 404 should render.

Usage

// basic usage
$string = $pagesRequest->getLoginPageOrUrl();

// usage with all arguments
$string = $pagesRequest->getLoginPageOrUrl($page = null);

Arguments

Name	Type(s)	Description
`page` (optional)	Page, null	Page that access was requested to or omit to get admin login page

Return value

string Page null

Hooking PagesRequest::getLoginPageOrUrl(…)

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

$this->addHookBefore('PagesRequest::getLoginPageOrUrl', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $PagesRequest = $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 PagesRequest::getLoginPageOrUrl(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

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

PagesRequest methods and properties

API reference based on ProcessWire core version 3.0.236