function FormStateInterface::getRedirect
Same name in other branches
- 9 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::getRedirect()
- 10 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::getRedirect()
- 11.x core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::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.
See also
\Drupal\Core\Form\FormSubmitterInterface::redirectForm()
2 methods override FormStateInterface::getRedirect()
- FormState::getRedirect in core/
lib/ Drupal/ Core/ Form/ FormState.php - Gets the value to use for redirecting after the form has been executed.
- FormStateDecoratorBase::getRedirect in core/
lib/ Drupal/ Core/ Form/ FormStateDecoratorBase.php - Gets the value to use for redirecting after the form has been executed.
File
-
core/
lib/ Drupal/ Core/ Form/ FormStateInterface.php, line 159
Class
- FormStateInterface
- Provides an interface for an object containing the current state of a form.
Namespace
Drupal\Core\FormCode
public function getRedirect();
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.