public function FormState::getRedirect in Drupal 8
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Form/FormState.php \Drupal\Core\Form\FormState::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
See also
\Drupal\Core\Form\FormSubmitterInterface::redirectForm()
File
- core/
lib/ Drupal/ Core/ Form/ FormState.php, line 1017
Class
- FormState
- Stores information about the state of a form.
Namespace
Drupal\Core\FormCode
public function getRedirect() {
// Skip redirection for form submissions invoked via
// \Drupal\Core\Form\FormBuilderInterface::submitForm().
if ($this
->isProgrammed()) {
return FALSE;
}
// Skip redirection if rebuild is activated.
if ($this
->isRebuilding()) {
return FALSE;
}
// Skip redirection if it was explicitly disallowed.
if ($this
->isRedirectDisabled()) {
return FALSE;
}
return $this->redirect;
}