function drupal_goto

Sends the user to a different Drupal page.

This issues an on-site HTTP redirect. The function makes sure the redirected URL is formatted correctly.

If a destination was specified in the current request's URI (i.e., $_GET['destination']) then it will override the $path and $options values passed to this function. This provides the flexibility to build a link to user/login and override the default redirection so that the user is redirected to a specific path after logging in:

$query = array(
  'destination' => "node/{$node->nid}",
);
$link = l(t('Log in'), 'user/login', array(
  'query' => $query,
));

Drupal will ensure that messages set by drupal_set_message() and other session data are written to the database before the user is redirected.

This function ends the request; use it instead of a return in your menu callback.

Parameters

$path: (optional) A Drupal path or a full URL, which will be passed to url() to compute the redirect for the URL.

$options: (optional) An associative array of additional URL options to pass to url().

$http_response_code: (optional) The HTTP status code to use for the redirection, defaults to 302. The valid values for 3xx redirection status codes are defined in RFC 2616 and the draft for the new HTTP status codes:

• 301: Moved Permanently (the recommended value for most redirects).
• 302: Found (default in Drupal and PHP, sometimes used for spamming search engines).
• 303: See Other.
• 304: Not Modified.
• 305: Use Proxy.
• 307: Temporary Redirect.

See also

drupal_get_destination()

url()

Related topics

File

drupal/core/includes/common.inc, line 684

Common functions that many Drupal modules will need to reference.

Code

function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {

  // A destination in $_GET always overrides the function arguments.
  // We do not allow absolute URLs to be passed via $_GET, as this can be an
  // attack vector, with the following exception:
  // - Absolute URLs that point to this site (i.e. same base URL and
  //   base path) are allowed.
  if (isset($_GET['destination']) && (!url_is_external($_GET['destination']) || _external_url_is_local($_GET['destination']))) {
    $destination = drupal_parse_url($_GET['destination']);
    $path = $destination['path'];
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
  }
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

  // The 'Location' HTTP header must be absolute.
  $options['absolute'] = TRUE;
  $url = Drupal::urlGenerator()
    ->generateFromPath($path, $options);
  if (drupal_get_bootstrap_phase() == DRUPAL_BOOTSTRAP_FULL) {
    drupal_session_commit();
  }
  $response = new RedirectResponse($url, $http_response_code);

  // @todo We should not send the response here: http://drupal.org/node/1668866
  $response
    ->sendHeaders();

  // The "Location" header sends a redirect status code to the HTTP daemon. In
  // some cases this can be wrong, so we make sure none of the code below the
  // drupal_goto() call gets executed upon redirection.
  exit;
}