function drupal_get_destination in Drupal 6

Same name and namespace in other branches

1. 8 core/includes/common.inc \drupal_get_destination()
2. 4 includes/common.inc \drupal_get_destination()
3. 5 includes/common.inc \drupal_get_destination()
4. 7 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

drupal_goto()

Related topics

15 calls to drupal_get_destination()

comment_admin_overview in modules/comment/comment.admin.inc

Form builder; Builds the comment overview form for the admin.

node_admin_nodes in modules/node/node.admin.inc

Form builder: Builds the node administration overview.

node_form_delete_submit in modules/node/node.pages.inc

Button sumit function: handle the 'Delete' button on the node form.

openid_authentication in modules/openid/openid.module

Authenticate a user or attempt registration.

path_admin_overview in modules/path/path.admin.inc

Return a listing of all defined URL aliases. When filter key passed, perform a standard search on the given key, and return the list of matching URL aliases.

... See full list

File

includes/common.inc, line 272

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);
  }
}