function FormState::setError

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

Flags an element as having an error.

Parameters

array $element: The form element.

string|\Stringable $message: (optional) The error message to present to the user.

Return value

$this

Overrides FormStateInterface::setError

File

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

Class

FormState
Stores information about the state of a form.

Namespace

Drupal\Core\Form

Code

public function setError(array &$element, $message = '') {
    $this->setErrorByName(implode('][', $element['#parents']), $message);
    return $this;
}

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