drupal_get_destination
function drupal_get_destination
drupal_get_destination()
Prepares a 'destination' URL query parameter for use 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.
Return value
An associative array containing the key:
- destination: The path provided via the destination query string or, if not available, the current path.
See also
Related topics
File
- includes/common.inc, line 525
- Common functions that many Drupal modules will need to reference.
Code
function drupal_get_destination() { $destination = &drupal_static(__FUNCTION__); if (isset($destination)) { return $destination; } if (isset($_GET['destination'])) { $destination = array('destination' => $_GET['destination']); } else { $path = $_GET['q']; $query = drupal_http_build_query(drupal_get_query_parameters()); if ($query != '') { $path .= '?' . $query; } $destination = array('destination' => $path); } return $destination; }
© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_get_destination/7.x