function FormState::getRedirect

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

Overrides FormStateInterface::getRedirect

File

core/lib/Drupal/Core/Form/FormState.php, line 1064

Class

FormState
Stores information about the state of a form.

Namespace

Drupal\Core\Form

Code

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;
}

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