1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Routing
  7. \
  8. RedirectDestinationInterface

RedirectDestinationInterface

interface RedirectDestinationInterface (View source)

Provides an interface for redirect destinations.

Methods

array
getAsArray()

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

string
get()

Gets the destination as a path.

$this
set(string $new_destination)

Sets the destination as URL.

Details

at line 29
array 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

RedirectResponseSubscriber::checkRedirectUrl

at line 42
string get()

Gets the destination as a path.

To convert to a URL suitable for \Symfony\Component\HttpFoundation\RedirectResponse::__construct() use

Return Value

string

at line 55
$this set(string $new_destination)

Sets the destination as URL.

This method should be used really rarely, for example views uses it, in order to override all destination calls in all of its rendering.

Parameters

string $new_destination

The new destination.

Return Value

$this