$session->redirect() method

Redirect this session to another URL.

Execution halts within this function after redirect has been issued.

Example

// redirect to homepage
$session->redirect('/'); 

Usage

// basic usage
$session->redirect(string $url);

// usage with all arguments
$session->redirect(string $url, $status = 301);

Arguments

NameType(s)Description
urlstring

URL to redirect to

status (optional)bool, int

One of the following (or omit for 301):

  • true (bool): Permanent redirect (same as 301).
  • false (bool): Temporary redirect (same as 302).
  • 301 (int): Permanent redirect using GET. (3.0.166+)
  • 302 (int): “Found”, Temporary redirect using GET. (3.0.166+)
  • 303 (int): “See other”, Temporary redirect using GET. (3.0.166+)
  • 307 (int): Temporary redirect using current request method such as POST (repeat that request). (3.0.166+)

Hooking $session->redirect(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('Session::redirect', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $session = $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)
  $url = $event->arguments(0);
  $status = $event->arguments(1);

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

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

See Also


$session methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • Weekly update, July 29: Continuing upgrades to ProcessWire’s comments system and FormBuilder, along with a working example—More
    29 July 2022
  • Weekly update for July 22– Looking back at what web development was like in the year 2000. Plus some more discussion on the path from CKEditor 4 to CkEditor 5 in ProcessWire: More
    22 July 2022
  • ProcessWire 3.0.203 core updates: new support for custom fields on comments and more— More
    15 July 2022

Latest news

  • ProcessWire Weekly #429
    In the 429th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module, and more. Read on!
    Weekly.pw / 30 July 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani