$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, bool $http301 = true);

Arguments

NameType(s)Description
urlstring

URL to redirect to

http301 (optional)bool

Should this be a permanent (301) redirect? (default=true). If false, it is a 302 temporary redirect.


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);
  $http301 = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

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);
  $http301 = $event->arguments(1);

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

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

$session methods and properties

API reference based on ProcessWire core version 3.0.130

Twitter updates

  • New post: ProcessWire 3.0.131 adds support for partial/resumable downloads and http stream delivery, and contains several updates to our comments system, among other updates— More
    3 May 2019
  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019

Latest news

  • ProcessWire Weekly #262
    The 262nd issue of ProcessWire Weekly will cover the latest module updates, both Pro modules and non-commercial ones. We've also got some highlights from the support forum, and a beautiful new site of the week. Read on!
    Weekly.pw / 18 May 2019
  • Lots of module updates
    In this post we take a quick look at the new version of ProFields Repeater Matrix, yet another new version of FormBuilder, and a new version of the GoogleClientAPI module.
    Blog / 17 May 2019
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer