You are here

public function FormState::setError in Drupal 9

Same name and namespace in other branches
  1. 8 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 $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 1093

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