function FormStateInterface::getError

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

Returns the error message filed against the given form element.

Form errors higher up in the form structure override deeper errors as well as errors on the element itself.

Parameters

array $element: The form element to check for errors.

Return value

string|null Either the error message for this element or NULL if there are no errors.

2 methods override FormStateInterface::getError()
FormState::getError in core/lib/Drupal/Core/Form/FormState.php
Returns the error message filed against the given form element.
FormStateDecoratorBase::getError in core/lib/Drupal/Core/Form/FormStateDecoratorBase.php
Returns the error message filed against the given form element.

File

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

Class

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

Namespace

Drupal\Core\Form

Code

public function getError(array $element);

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