Same name and namespace in other branches
- 4.6.x includes/common.inc \drupal_get_destination()
- 5.x includes/common.inc \drupal_get_destination()
- 6.x includes/common.inc \drupal_get_destination()
- 7.x includes/common.inc \drupal_get_destination()
- 8.9.x core/includes/common.inc \drupal_get_destination()
Prepare a destination query string for use in combination with drupal_goto(). Used to direct the user back to the referring page after completing a form. By default the current URL is returned. If a destination exists in the previous request, that destination is returned. As such, a destination can persist across multiple pages.
See also
6 calls to drupal_get_destination()
- comment_admin_overview in modules/
comment.module - Menu callback; present an administrative comment listing.
- node_admin_nodes in modules/
node.module - Menu callback: content administration.
- path_overview in modules/
path.module - Return a listing of all defined URL aliases.
- statistics_top_visitors in modules/
statistics.module - Menu callback; presents the "top visitors" page.
- taxonomy_overview_terms in modules/
taxonomy.module - Display a tree of all the terms in a vocabulary, with options to edit each one.
File
- includes/
common.inc, line 206 - Common functions that many Drupal modules will need to reference.
Code
function drupal_get_destination() {
if (isset($_REQUEST['destination'])) {
return 'destination=' . urlencode($_REQUEST['destination']);
}
else {
// Use $_GET here to retrieve the original path in source form.
$path = isset($_GET['q']) ? $_GET['q'] : '';
$query = drupal_query_string_encode($_GET, array(
'q',
));
if ($query != '') {
$path .= '?' . $query;
}
return 'destination=' . urlencode($path);
}
}