function drupal_goto in Drupal 7

Same name and namespace in other branches

1. 4 includes/common.inc \drupal_goto()
2. 5 includes/common.inc \drupal_goto()
3. 6 includes/common.inc \drupal_goto()

Sends the user to a different page.

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

Usually the redirected URL is constructed from this function's input parameters. However you may override that behavior by setting a destination in either the $_REQUEST-array (i.e. by using the query string of an URI) This is used to direct the user back to the proper page after completing a form. For example, after editing a post on the 'admin/content'-page or after having logged on using the 'user login'-block in a sidebar. The function drupal_get_destination() can be used to help set the destination URL.

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

45 calls to drupal_goto()

aggregator_admin_refresh_feed in modules/aggregator/aggregator.admin.inc

Page callback: Refreshes a feed, then redirects to the overview page.

comment_approve in modules/comment/comment.pages.inc

Menu callback; publish specified comment.

comment_multiple_delete_confirm in modules/comment/comment.admin.inc

List the selected comments and verify that the admin wants to delete them.

comment_reply in modules/comment/comment.pages.inc

This function is responsible for generating a comment reply form. There are several cases that have to be handled, including:

common_test_drupal_goto_redirect in modules/simpletest/tests/common_test.module

Redirect using drupal_goto().

... See full list

4 string references to 'drupal_goto'

common_test_drupal_goto_land in modules/simpletest/tests/common_test.module

Landing page for drupal_goto().

common_test_menu in modules/simpletest/tests/common_test.module

Implements hook_menu().

DrupalGotoTest::testDrupalGoto in modules/simpletest/tests/common.test

Test drupal_goto().

drupal_redirect_form in includes/form.inc

Redirects the user to a URL after a form has been processed.

File

includes/common.inc, line 682

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.
  if (isset($_GET['destination']) && !url_is_external($_GET['destination'])) {
    $destination = drupal_parse_url($_GET['destination']);

    // Double check the path derived by drupal_parse_url() is not external.
    if (!url_is_external($destination['path'])) {
      $path = $destination['path'];
    }
    $options['query'] = $destination['query'];
    $options['fragment'] = $destination['fragment'];
  }

  // In some cases modules call drupal_goto(current_path()). We need to ensure
  // that such a redirect is not to an external URL.
  if ($path === current_path() && empty($options['external']) && url_is_external($path)) {

    // Force url() to generate a non-external URL.
    $options['external'] = FALSE;
  }
  drupal_alter('drupal_goto', $path, $options, $http_response_code);

  // The 'Location' HTTP header must be absolute.
  $options['absolute'] = TRUE;
  $url = url($path, $options);
  header('Location: ' . $url, TRUE, $http_response_code);

  // 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.
  drupal_exit($url);
}