function FormStateInterface::setMethod

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

Sets the HTTP method to use for the form's submission.

This is what the form's "method" attribute should be, not necessarily what the current request's HTTP method is. For example, a form can have a method attribute of POST, but the request that initially builds it uses GET.

Parameters

string $method: Either "GET" or "POST". Other HTTP methods are not valid form submission methods.

Return value

$this

See also

\Drupal\Core\Form\FormState::$method

\Drupal\Core\Form\FormStateInterface::setRequestMethod()

2 methods override FormStateInterface::setMethod()
FormState::setMethod in core/lib/Drupal/Core/Form/FormState.php
Sets the HTTP method to use for the form's submission.
FormStateDecoratorBase::setMethod in core/lib/Drupal/Core/Form/FormStateDecoratorBase.php
Sets the HTTP method to use for the form's submission.

File

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

Class

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

Namespace

Drupal\Core\Form

Code

public function setMethod($method);

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