Classes, traits, and interfaces - Drupal 11.1.x - Drupal Core

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 1518

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
ForbiddenCommentsSniff class SlevomatCodingStandard\Sniffs\Commenting vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenCommentsSniff.php
ForbiddenFunctionsSniff class PHP_CodeSniffer\Standards\Generic\Sniffs\PHP vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/PHP/ForbiddenFunctionsSniff.php 3 2
ForbiddenPublicPropertySniff final class SlevomatCodingStandard\Sniffs\Classes vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ForbiddenPublicPropertySniff.php
ForbiddenStylesSniff class PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/CSS/ForbiddenStylesSniff.php
ForEachLoopDeclarationSniff class PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/ControlStructures/ForEachLoopDeclarationSniff.php
Foreach_ class PhpParser\Node\Stmt vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/Foreach_.php 1
ForInStatement class Peast\Syntax\Node vendor/mck89/peast/lib/Peast/Syntax/Node/ForInStatement.php A node that represents a for-in statement. For example: for (var a in b) {} 1
ForkCMSInstaller class Composer\Installers vendor/composer/installers/src/Composer/Installers/ForkCMSInstaller.php
ForLoopDeclarationSniff class PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/ControlStructures/ForLoopDeclarationSniff.php
ForLoopInfo class VariableAnalysis\Lib vendor/sirbrillig/phpcs-variable-analysis/VariableAnalysis/Lib/ForLoopInfo.php Holds details of a for loop. 1
ForLoopNode class Twig\Node vendor/twig/twig/src/Node/ForLoopNode.php Internal node used by the for node.
ForLoopShouldBeWhileLoopSniff class PHP_CodeSniffer\Standards\Generic\Sniffs\CodeAnalysis vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/CodeAnalysis/ForLoopShouldBeWhileLoopSniff.php
ForLoopWithTestFunctionCallSniff class PHP_CodeSniffer\Standards\Generic\Sniffs\CodeAnalysis vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/CodeAnalysis/ForLoopWithTestFunctionCallSniff.php
Form class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Form.php Provides a render element for a form.
Form class Symfony\Component\DomCrawler vendor/symfony/dom-crawler/Form.php Form represents an HTML form. 2
FormAjaxException class Drupal\Core\Form core/lib/Drupal/Core/Form/FormAjaxException.php Custom exception to break out of AJAX form processing. 1
FormAjaxResponseBuilder class Drupal\Core\Form core/lib/Drupal/Core/Form/FormAjaxResponseBuilder.php Builds an AJAX form response.
FormAjaxResponseBuilderInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/FormAjaxResponseBuilderInterface.php Provides an interface for building AJAX form responses. 1 1
FormAjaxSubscriber class Drupal\Core\Form\EventSubscriber core/lib/Drupal/Core/Form/EventSubscriber/FormAjaxSubscriber.php Wraps AJAX form submissions that are triggered via an exception.
FormAlterDocSniff class DrupalPractice\Sniffs\FunctionDefinitions vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/FormAlterDocSniff.php Checks that the comment "Implements hook_form_alter()." actually matches the function signature.
FormatConstraint class JsonSchema\Constraints vendor/justinrainbow/json-schema/src/JsonSchema/Constraints/FormatConstraint.php Validates against the "format" property
FormatDate class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/FormatDate.php Converts date/datetime from one format to another.
FormattableMarkup class Drupal\Component\Render core/lib/Drupal/Component/Render/FormattableMarkup.php Formats a string for HTML display by replacing variable placeholders. 1 33
FormattedDateDiff class Drupal\Core\Datetime core/lib/Drupal/Core/Datetime/FormattedDateDiff.php Contains a formatted time difference.
Formatter class OpenTelemetry\API\Behavior\Internal\LogWriter vendor/open-telemetry/api/Behavior/Internal/LogWriter/Formatter.php
Formatter interface phpDocumentor\Reflection\DocBlock\Tags vendor/phpdocumentor/reflection-docblock/src/DocBlock/Tags/Formatter.php 2 5
FormatterBase abstract class Drupal\Core\Field core/lib/Drupal/Core/Field/FormatterBase.php Base class for 'Field formatter' plugin implementations. 24 24
FormatterHelper class Symfony\Component\Console\Helper vendor/symfony/console/Helper/FormatterHelper.php The Formatter class provides helpers to format messages. 2
FormatterInterface interface Drupal\Core\Field core/lib/Drupal/Core/Field/FormatterInterface.php Interface definition for field formatter plugins. 1 2 1
FormatterPluginManager class Drupal\Core\Field core/lib/Drupal/Core/Field/FormatterPluginManager.php Plugin type manager for field formatters. 3
FormBase abstract class Drupal\Core\Form core/lib/Drupal/Core/Form/FormBase.php Provides a base class for forms. 54 52
FormBuilder class Drupal\Core\Form core/lib/Drupal/Core/Form/FormBuilder.php Provides form building and processing.
FormBuilderInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/FormBuilderInterface.php Provides an interface for form building and processing. 1 21
FormCache class Drupal\Core\Form core/lib/Drupal/Core/Form/FormCache.php Encapsulates the caching of a form and its form state.
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
FormController abstract class Drupal\Core\Controller core/lib/Drupal/Core/Controller/FormController.php Common base class for form interstitial controllers. 4 3
FormDataPart final class Symfony\Component\Mime\Part\Multipart vendor/symfony/mime/Part/Multipart/FormDataPart.php Implements RFC 7578. 2
FormElement class Drupal\Core\Render\Annotation core/lib/Drupal/Core/Render/Annotation/FormElement.php Defines a form element plugin annotation object.
FormElement class Drupal\Core\Render\Attribute core/lib/Drupal/Core/Render/Attribute/FormElement.php Defines a form element plugin attribute object. 37
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.
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. 1
FormElementInterface interface Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/FormElementInterface.php Provides an interface for form element plugins. 1 1
FormErrorHandler class Drupal\Core\Form core/lib/Drupal/Core/Form/FormErrorHandler.php Handles form errors. 1 1
FormErrorHandler class Drupal\inline_form_errors core/modules/inline_form_errors/src/FormErrorHandler.php Produces inline form errors.
FormErrorHandlerInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/FormErrorHandlerInterface.php Provides an interface for handling form errors. 1
FormErrorNormalizer final class Symfony\Component\Serializer\Normalizer vendor/symfony/serializer/Normalizer/FormErrorNormalizer.php Normalizes invalid Form instances. 1
FormErrorNormalizerContextBuilder final class Symfony\Component\Serializer\Context\Normalizer vendor/symfony/serializer/Context/Normalizer/FormErrorNormalizerContextBuilder.php A helper providing autocompletion for available FormErrorNormalizer options.
FormErrorTSniff class DrupalPractice\Sniffs\FunctionCalls vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/FormErrorTSniff.php Verifies that messages passed to form_set_error() run through t().