function drupal_get_destination

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.

See also

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

Related topics

Form generation

Describes how to generate and manipulate forms and process form submissions.

File

core/includes/common.inc, line 158

Common functions that many Drupal modules will need to reference.

Code

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