8.5.x RedirectDestinationInterface.php RedirectDestinationInterface::getAsArray()
8.0.x RedirectDestinationInterface.php RedirectDestinationInterface::getAsArray()
8.1.x RedirectDestinationInterface.php RedirectDestinationInterface::getAsArray()
8.2.x RedirectDestinationInterface.php RedirectDestinationInterface::getAsArray()
8.3.x RedirectDestinationInterface.php RedirectDestinationInterface::getAsArray()
8.4.x RedirectDestinationInterface.php RedirectDestinationInterface::getAsArray()
8.6.x RedirectDestinationInterface.php RedirectDestinationInterface::getAsArray()

Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.

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 current 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

1 method overrides RedirectDestinationInterface::getAsArray()
RedirectDestination::getAsArray in core/lib/Drupal/Core/Routing/RedirectDestination.php
Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.

File

core/lib/Drupal/Core/Routing/RedirectDestinationInterface.php, line 29

Class

RedirectDestinationInterface
Provides an interface for redirect destinations.

Namespace

Drupal\Core\Routing

Code

public function getAsArray();