function drupal_get_destination

Same name in other branches
  1. 7.x includes/common.inc \drupal_get_destination()

Prepares a 'destination' URL query parameter.

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

array An associative array containing the key:

  • destination: The value of the current request's 'destination' query parameter, if present. This can be either a relative or absolute URL. However, for security, redirection to external URLs is not performed. If the query parameter isn't present, then the URL of the current request is returned.

Deprecated

in drupal:8.0.0 and is removed from drupal:9.0.0. Use the redirect.destination service.

See also

\Drupal\Core\EventSubscriber\RedirectResponseSubscriber::checkRedirectUrl()

https://www.drupal.org/node/2448603

Related topics

File

core/includes/common.inc, line 158

Code

function drupal_get_destination() {
    return \Drupal::destination()->getAsArray();
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.