$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

  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022
  • ProcessWire 3.0.198 core updates: in this post we take a closer look at 3 useful new features added in this version— More
    15 April 2022

Latest news

  • ProcessWire Weekly #418
    In the 418th issue of ProcessWire Weekly we'll cover recent highlights, share some tips and tricks, and check out the new master version of ProcessWire, 3.0.200. Read on!
    Weekly.pw / 14 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK