interface FormInterface
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Form/FormInterface.php \Drupal\Core\Form\FormInterface
- 10 core/lib/Drupal/Core/Form/FormInterface.php \Drupal\Core\Form\FormInterface
- 11.x core/lib/Drupal/Core/Form/FormInterface.php \Drupal\Core\Form\FormInterface
Provides an interface for a Form.
Hierarchy
- interface \Drupal\Core\Form\FormInterface
Expanded class hierarchy of FormInterface
All classes that implement FormInterface
Related topics
39 files declare their use of FormInterface
- ActionsTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Render/ Element/ ActionsTest.php - AjaxFormBlock.php in core/
modules/ system/ tests/ modules/ ajax_forms_test/ src/ Plugin/ Block/ AjaxFormBlock.php - AjaxTestFocusFirstForm.php in core/
modules/ system/ tests/ modules/ ajax_test/ src/ Form/ AjaxTestFocusFirstForm.php - AjaxTestMessageCommandForm.php in core/
modules/ system/ tests/ modules/ ajax_test/ src/ Form/ AjaxTestMessageCommandForm.php - BlockListBuilder.php in core/
modules/ block/ src/ BlockListBuilder.php
File
-
core/
lib/ Drupal/ Core/ Form/ FormInterface.php, line 10
Namespace
Drupal\Core\FormView source
interface FormInterface {
/**
* Returns a unique string identifying the form.
*
* The returned ID should be a unique string that can be a valid PHP function
* name, since it's used in hook implementation names such as
* hook_form_FORM_ID_alter().
*
* @return string
* The unique string identifying the form.
*/
public function getFormId();
/**
* Form constructor.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @return array
* The form structure.
*/
public function buildForm(array $form, FormStateInterface $form_state);
/**
* Form validation handler.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*/
public function validateForm(array &$form, FormStateInterface $form_state);
/**
* Form submission handler.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*/
public function submitForm(array &$form, FormStateInterface $form_state);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
FormInterface::buildForm | public | function | Form constructor. | 198 |
FormInterface::getFormId | public | function | Returns a unique string identifying the form. | 270 |
FormInterface::submitForm | public | function | Form submission handler. | 220 |
FormInterface::validateForm | public | function | Form validation handler. | 35 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.