Community Documentation

drupal_get_destination

5 common.inc drupal_get_destination()
6 common.inc drupal_get_destination()
7 common.inc drupal_get_destination()
8 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

drupal_goto()

▾ 10 functions call drupal_get_destination()

comment_admin_overview in modules/comment/comment.module
node_admin_nodes in modules/node/node.module
node_page_edit in modules/node/node.module
Menu callback; presents the node editing form, or redirects to delete confirmation.
path_overview in modules/path/path.module
Return a listing of all defined URL aliases.
statistics_top_visitors in modules/statistics/statistics.module
Menu callback; presents the "top visitors" page.
taxonomy_overview_terms in modules/taxonomy/taxonomy.module
Display a tree of all the terms in a vocabulary, with options to edit each one.
theme_forum_display in modules/forum/forum.module
Format the forum body.
user_admin_account in modules/user/user.module
user_edit in modules/user/user.module
user_login_block in modules/user/user.module

File

includes/common.inc, line 247
Common functions that many Drupal modules will need to reference.

Code

<?php
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);
  }
}
?>
Login or register to post comments