function FormStateInterface::setRedirect

Same name in other branches
  1. 9 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::setRedirect()
  2. 10 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::setRedirect()
  3. 11.x core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::setRedirect()

Sets the redirect for the form.

Parameters

string $route_name: The name of the route

array $route_parameters: (optional) An associative array of parameter names and values.

array $options: (optional) An associative array of additional options containing the same values accepted from \Drupal\Core\Url::fromUri() for $options.

Return value

$this

See also

\Drupal\Core\Form\FormSubmitterInterface::redirectForm()

\Drupal\Core\Url::fromUri()

2 methods override FormStateInterface::setRedirect()
FormState::setRedirect in core/lib/Drupal/Core/Form/FormState.php
Sets the redirect for the form.
FormStateDecoratorBase::setRedirect in core/lib/Drupal/Core/Form/FormStateDecoratorBase.php
Sets the redirect for the form.

File

core/lib/Drupal/Core/Form/FormStateInterface.php, line 132

Class

FormStateInterface
Provides an interface for an object containing the current state of a form.

Namespace

Drupal\Core\Form

Code

public function setRedirect($route_name, array $route_parameters = [], array $options = []);

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