W3cubDocs

/Drupal 8

public function FormBuilder::validateForm

public FormBuilder::validateForm($form_id, &$form, FormStateInterface &$form_state)

Validates user-submitted form data in the $form_state.

Parameters

$form_id: A unique string identifying the form for validation, submission, theming, and hook_form_alter functions.

$form: An associative array containing the structure of the form, which is passed by reference. Form validation handlers are able to alter the form structure (like #process and #after_build callbacks during form building) in case of a validation error. If a validation handler alters the form structure, it is responsible for validating the values of changed form elements in $form_state->getValues() to prevent form submit handlers from receiving unvalidated values.

$form_state: The current state of the form. The current user-submitted data is stored in $form_state->getValues(), though form validation functions are passed an explicit copy of the values for the sake of simplicity. Validation handlers can also use $form_state to pass information on to submit handlers. For example: $form_state->set('data_for_submission', $data); This technique is useful when validation requires file parsing, web service requests, or other expensive requests that should not be repeated in the submission step.

Overrides FormValidatorInterface::validateForm

File

core/lib/Drupal/Core/Form/FormBuilder.php, line 855

Class

FormBuilder
Provides form building and processing.

Namespace

Drupal\Core\Form

Code

public function validateForm($form_id, &$form, FormStateInterface &$form_state) {
  $this->formValidator->validateForm($form_id, $form, $form_state);
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Form!FormBuilder.php/function/FormBuilder::validateForm/8.1.x