function FormStateDecoratorBase::getRedirect

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Form/FormStateDecoratorBase.php \Drupal\Core\Form\FormStateDecoratorBase::getRedirect()
  2. 8.9.x core/lib/Drupal/Core/Form/FormStateDecoratorBase.php \Drupal\Core\Form\FormStateDecoratorBase::getRedirect()
  3. 10 core/lib/Drupal/Core/Form/FormStateDecoratorBase.php \Drupal\Core\Form\FormStateDecoratorBase::getRedirect()

Gets the value to use for redirecting after the form has been executed.

Return value

mixed The value will be one of the following:

  • A fully prepared \Symfony\Component\HttpFoundation\RedirectResponse.
  • An instance of \Drupal\Core\Url to use for the redirect.
  • NULL, to signify that no redirect was specified and that the current path should be used for the redirect.
  • FALSE, to signify that no redirect should take place.

Overrides FormStateInterface::getRedirect

File

core/lib/Drupal/Core/Form/FormStateDecoratorBase.php, line 610

Class

FormStateDecoratorBase
Decorates another form state.

Namespace

Drupal\Core\Form

Code

public function getRedirect() {
  return $this->decoratedFormState
    ->getRedirect();
}

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