Classes, traits, and interfaces - main - drupal

Primary tabs

Introduction to classes

A lot of the PHP code in Drupal is object oriented (OO), making use of PHP classes, interfaces, and traits. See the Objected-oriented programming conventions for more information.

See also

Objected-oriented programming conventions

File

core/core.api.php, line 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
FormatterInterface interface Drupal\Core\Field core/lib/Drupal/Core/Field/FormatterInterface.php Interface definition for field formatter plugins. 1 3 1
FormatterPluginManager class Drupal\Core\Field core/lib/Drupal/Core/Field/FormatterPluginManager.php Plugin type manager for field formatters. 6 2
FormatterPluginManagerTest class Drupal\Tests\field\Kernel core/modules/field/tests/src/Kernel/FormatterPluginManagerTest.php Tests the field formatter plugin manager.
FormBase abstract class Drupal\Core\Form core/lib/Drupal/Core/Form/FormBase.php Provides a base class for forms. 159 153
FormBuilder class Drupal\Core\Form core/lib/Drupal/Core/Form/FormBuilder.php Provides form building and processing. 3 2
FormBuilderInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/FormBuilderInterface.php Provides an interface for form building and processing. 1 35
FormBuilderTest class Drupal\Tests\Core\Form core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php Tests Drupal\Core\Form\FormBuilder.
FormCache class Drupal\Core\Form core/lib/Drupal/Core/Form/FormCache.php Encapsulates the caching of a form and its form state. 1 2
FormCacheInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/FormCacheInterface.php Provides an interface for the caching of a form and its form state. 2 1
FormCacheTest class Drupal\Tests\Core\Form core/tests/Drupal/Tests/Core/Form/FormCacheTest.php Tests Drupal\Core\Form\FormCache.
FormCacheTest class Drupal\KernelTests\Core\Form core/tests/Drupal/KernelTests/Core/Form/FormCacheTest.php Tests FormBuilder caching.
FormClassMissingName class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/UnsupportedRouteAttributePropertiesTest.php Test class.
FormClassRouteCondition class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/UnsupportedRouteAttributePropertiesTest.php Test class.
FormClassRouteLocale class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/UnsupportedRouteAttributePropertiesTest.php Test class.
FormClassRouteLocalizedPaths class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/UnsupportedRouteAttributePropertiesTest.php Test class.
FormController abstract class Drupal\Core\Controller core/lib/Drupal/Core/Controller/FormController.php Common base class for form interstitial controllers. 3 2
FormController class Drupal\condition_test core/modules/system/tests/modules/condition_test/src/FormController.php Routing controller class for condition_test testing of condition forms. 1
FormDefaultHandlersTest class Drupal\KernelTests\Core\Form core/tests/Drupal/KernelTests/Core/Form/FormDefaultHandlersTest.php Tests automatically added form handlers.
FormElement class Drupal\Core\Render\Attribute core/lib/Drupal/Core/Render/Attribute/FormElement.php Defines a form element plugin attribute object. 39
FormElement

in drupal:10.3.0 and is removed from drupal:12.0.0. use \Drupal\Core\Render\Element\FormElementBase instead.

abstract class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/FormElement.php Provides a base class for form element plugins. 1 1
FormElement class Drupal\Core\Render\Annotation core/lib/Drupal/Core/Render/Annotation/FormElement.php Defines a form element plugin annotation object.
FormElementBase abstract class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/FormElementBase.php Provides a base class for form element plugins. 28 3
FormElementBase abstract class Drupal\config_translation\FormElement core/modules/config_translation/src/FormElement/FormElementBase.php Provides a common base class for form elements. 5
FormElementHelper class Drupal\Core\Form core/lib/Drupal/Core/Form/FormElementHelper.php Provides common functionality for form elements. 2
FormElementHelperTest class Drupal\Tests\Core\Form core/tests/Drupal/Tests/Core/Form/FormElementHelperTest.php Tests the form element helper.
FormElementInlineErrorTest class Drupal\Tests\inline_form_errors\Kernel core/modules/inline_form_errors/tests/src/Kernel/FormElementInlineErrorTest.php Tests messages on form elements.
FormElementInterface interface Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/FormElementInterface.php Provides an interface for form element plugins. 2 1
FormElementLabelTest class Drupal\Tests\system\Kernel\Form core/modules/system/tests/src/Kernel/Form/FormElementLabelTest.php Tests for form_element_label theme hook.
FormElementMaxlengthTest class Drupal\Tests\system\Kernel\Form core/modules/system/tests/src/Kernel/Form/FormElementMaxlengthTest.php Tests the maxlength HTML attribute on form elements.
FormElementsRenderTest class Drupal\Tests\system\Kernel\Common core/modules/system/tests/src/Kernel/Common/FormElementsRenderTest.php Performs integration tests on \Drupal::service('renderer')->render().
FormErrorHandler class Drupal\inline_form_errors core/modules/inline_form_errors/src/FormErrorHandler.php Produces inline form errors. 1
FormErrorHandler class Drupal\Core\Form core/lib/Drupal/Core/Form/FormErrorHandler.php Handles form errors. 1 2 2
FormErrorHandlerCKEditor5Test class Drupal\Tests\inline_form_errors\FunctionalJavascript core/modules/inline_form_errors/tests/src/FunctionalJavascript/FormErrorHandlerCKEditor5Test.php Tests the inline errors fragment link to a CKEditor5-enabled textarea.
FormErrorHandlerFileUploadTest class Drupal\Tests\inline_form_errors\Functional core/modules/inline_form_errors/tests/src/Functional/FormErrorHandlerFileUploadTest.php Tests file upload scenario's with Inline Form Errors.
FormErrorHandlerInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/FormErrorHandlerInterface.php Provides an interface for handling form errors. 1 2
FormErrorHandlerTest class Drupal\Tests\inline_form_errors\Unit core/modules/inline_form_errors/tests/src/Unit/FormErrorHandlerTest.php Tests Drupal\inline_form_errors\FormErrorHandler.
FormErrorHandlerTest class Drupal\Tests\Core\Form core/tests/Drupal/Tests/Core/Form/FormErrorHandlerTest.php Tests Drupal\Core\Form\FormErrorHandler.
FormGroupingElementsTest class Drupal\FunctionalJavascriptTests\Core\Form core/tests/Drupal/FunctionalJavascriptTests/Core/Form/FormGroupingElementsTest.php Tests for form grouping elements.
FormHelper class Drupal\Core\Form core/lib/Drupal/Core/Form/FormHelper.php Provides helpers to operate on forms. 6
FormHelperTest class Drupal\Tests\Core\Form core/tests/Drupal/Tests/Core/Form/FormHelperTest.php Tests Drupal\Core\Form\FormHelper.
FormHooks class Drupal\admin\Hook core/themes/admin/src/Hook/FormHooks.php Provides form related hook implementations.
FormHooks class Drupal\default_admin\Hook core/themes/default_admin/src/Hook/FormHooks.php Provides form related hook implementations.
FormInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/FormInterface.php Provides an interface for a Form. 42 45
FormModeAccessCheck class Drupal\field_ui\Access core/modules/field_ui/src/Access/FormModeAccessCheck.php Defines an access check for entity form mode routes. 2
FormObjectTest class Drupal\Tests\system\Kernel\Form core/modules/system/tests/src/Kernel/Form/FormObjectTest.php Tests building a form from an object.
FormObjectTest class Drupal\Tests\system\Functional\Form core/modules/system/tests/src/Functional/Form/FormObjectTest.php Tests building a form from an object.
FormOperations class Drupal\workspaces\Hook core/modules/workspaces/src/Hook/FormOperations.php Defines a class for reacting to form operations.
FormPreprocess class Drupal\Core\Form core/lib/Drupal/Core/Form/FormPreprocess.php Initial preprocess callbacks for the form system. 1 2
FormRouteEnhancer class Drupal\Core\Routing\Enhancer core/lib/Drupal/Core/Routing/Enhancer/FormRouteEnhancer.php Enhancer to add a wrapping controller for _form routes. 2
FormState class Drupal\Core\Form core/lib/Drupal/Core/Form/FormState.php Stores information about the state of a form. 88

Other projects


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