function drupal_goto
| 7.x common.inc | drupal_goto($path = '', array |
| 6.x common.inc | drupal_goto($path = '', $query = NULL, $fragment = NULL, $http_response_code = 302) |
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
url()
Related topics
- aggregator_admin_refresh_feed in drupal-7.x/
modules/ aggregator/ aggregator.admin.inc - Page callback: Refreshes a feed, then redirects to the overview page.
- comment_approve in drupal-7.x/
modules/ comment/ comment.pages.inc - Menu callback; publish specified comment.
- comment_multiple_delete_confirm in drupal-7.x/
modules/ comment/ comment.admin.inc - List the selected comments and verify that the admin wants to delete them.
- comment_reply in drupal-7.x/
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 drupal-7.x/
modules/ simpletest/ tests/ common_test.module - Redirect using drupal_goto().
- batch_process in drupal-7.x/
includes/ form.inc - Processes the batch.
- common_test_menu in drupal-7.x/
modules/ simpletest/ tests/ common_test.module - Implements hook_menu().
- DrupalGotoTest::testDrupalGoto in drupal-7.x/
modules/ simpletest/ tests/ common.test - Test drupal_goto().
- drupal_redirect_form in drupal-7.x/
includes/ form.inc - Redirects the user to a URL after a form has been processed.
- update_batch in drupal-7.x/
includes/ update.inc - Starts the database update batch process.
File
- drupal-7.x/
includes/ common.inc, line 686 - 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']);
$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 = 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);
}