You are here

Classes, traits, and interfaces in Drupal 9

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

Name	Type	Namespace	Location	Description	Direct uses	Use statements	Strings
AttachmentsTrait	trait	Drupal\Core\Render	core/lib/Drupal/Core/Render/AttachmentsTrait.php	Provides an implementation of AttachmentsInterface.		3
AttachmentTestFormatter	class	Drupal\views_test_formatter\Plugin\Field\FieldFormatter	core/modules/views/tests/modules/views_test_formatter/src/Plugin/Field/FieldFormatter/AttachmentTestFormatter.php	Plugin implementation of the 'number_unformatted_with_attachment' formatter.
Attribute	class	Drupal\Core\Template	core/lib/Drupal/Core/Template/Attribute.php	Collects, sanitizes, and renders HTML attributes.	1	37
AttributeArray	class	Drupal\Core\Template	core/lib/Drupal/Core/Template/AttributeArray.php	A class that defines a type of Attribute that can be added to as an array.		1
AttributeBoolean	class	Drupal\Core\Template	core/lib/Drupal/Core/Template/AttributeBoolean.php	A class that defines a type of boolean HTML attribute.
AttributeHelper	class	Drupal\Core\Template	core/lib/Drupal/Core/Template/AttributeHelper.php	Helper class to deal with mixed array and Attribute operations.		2
AttributeHelperTest	class	Drupal\Tests\Core\Template	core/tests/Drupal/Tests/Core/Template/AttributeHelperTest.php	@coversDefaultClass \Drupal\Core\Template\AttributeHelper @group Template
AttributesTest	class	Drupal\Tests\Core\Common	core/tests/Drupal/Tests/Core/Common/AttributesTest.php	Tests the Drupal\Core\Template\Attribute functionality.
AttributeString	class	Drupal\Core\Template	core/lib/Drupal/Core/Template/AttributeString.php	A class that represents most standard HTML attributes.		1
AttributeTest	class	Drupal\Tests\Core\Template	core/tests/Drupal/Tests/Core/Template/AttributeTest.php	@coversDefaultClass \Drupal\Core\Template\Attribute @group Template
AttributeValueBase	abstract class	Drupal\Core\Template	core/lib/Drupal/Core/Template/AttributeValueBase.php	Defines the base class for an attribute type.	3
AudioFile	class	Drupal\media\Plugin\media\Source	core/modules/media/src/Plugin/media/Source/AudioFile.php	Media source wrapping around an audio file.
AuditException	class	Drupal\migrate\Audit	core/modules/migrate/src/Audit/AuditException.php	Defines an exception to throw if an error occurs during a migration audit.
AuditorInterface	interface	Drupal\migrate\Audit	core/modules/migrate/src/Audit/AuditorInterface.php	Defines an interface for migration auditors.	1
AuditResult	class	Drupal\migrate\Audit	core/modules/migrate/src/Audit/AuditResult.php	Encapsulates the result of a migration audit.		2
Auth	class	Drupal\early_translation_test	core/modules/locale/tests/modules/early_translation_test/src/Auth.php	Test authentication provider.			2
AuthenticationCollector	class	Drupal\Core\Authentication	core/lib/Drupal/Core/Authentication/AuthenticationCollector.php	A collector class for authentication providers.		2	2
AuthenticationCollectorInterface	interface	Drupal\Core\Authentication	core/lib/Drupal/Core/Authentication/AuthenticationCollectorInterface.php	Interface for collectors of registered authentication providers.	1
AuthenticationCollectorTest	class	Drupal\Tests\Core\Authentication	core/tests/Drupal/Tests/Core/Authentication/AuthenticationCollectorTest.php	@coversDefaultClass \Drupal\Core\Authentication\AuthenticationCollector @group Authentication
AuthenticationManager	class	Drupal\Core\Authentication	core/lib/Drupal/Core/Authentication/AuthenticationManager.php	Manager for authentication.		1	2
AuthenticationManagerTest	class	Drupal\Tests\Core\Authentication	core/tests/Drupal/Tests/Core/Authentication/AuthenticationManagerTest.php	@coversDefaultClass \Drupal\Core\Authentication\AuthenticationManager @group Authentication
AuthenticationProviderChallengeInterface	interface	Drupal\Core\Authentication	core/lib/Drupal/Core/Authentication/AuthenticationProviderChallengeInterface.php	Generate a challenge when access is denied for unauthenticated users.	2	2
AuthenticationProviderFilterInterface	interface	Drupal\Core\Authentication	core/lib/Drupal/Core/Authentication/AuthenticationProviderFilterInterface.php	Restrict authentication methods to a subset of the site.	2	2
AuthenticationProviderInterface	interface	Drupal\Core\Authentication	core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php	Interface for authentication providers.	8	8
AuthenticationProviderPass	class	Drupal\Core\DependencyInjection\Compiler	core/lib/Drupal/Core/DependencyInjection/Compiler/AuthenticationProviderPass.php	Registers the authentication_providers container parameter.		2
AuthenticationProviderPassTest	class	Drupal\Tests\Core\DependencyInjection\Compiler	core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/AuthenticationProviderPassTest.php	@coversDefaultClass \Drupal\Core\DependencyInjection\Compiler\AuthenticationProviderPass @group DependencyInjection
AuthenticationSubscriber	class	Drupal\Core\EventSubscriber	core/lib/Drupal/Core/EventSubscriber/AuthenticationSubscriber.php	Authentication subscriber.			2
AuthorFormatter	class	Drupal\user\Plugin\Field\FieldFormatter	core/modules/user/src/Plugin/Field/FieldFormatter/AuthorFormatter.php	Plugin implementation of the 'author' formatter.
AuthorNameFormatter	class	Drupal\comment\Plugin\Field\FieldFormatter	core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php	Plugin implementation of the 'comment_username' formatter.
AutocompleteController	class	Drupal\form_test	core/modules/system/tests/modules/form_test/src/AutocompleteController.php	Defines a controller class with methods for autocompletion.
AutoIncrementingTestItem	class	Drupal\entity_test\Plugin\Field\FieldType	core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/AutoIncrementingTestItem.php	Defines the 'field_method_invocation_order_test' entity field type.
Autoload	class	Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Annotation	core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Annotation/Autoload.php
AutomatedCron	class	Drupal\automated_cron\EventSubscriber	core/modules/automated_cron/src/EventSubscriber/AutomatedCron.php	A subscriber running cron after a response is sent.			2
AutowireTest	class	Drupal\KernelTests\Core\DependencyInjection	core/tests/Drupal/KernelTests/Core/DependencyInjection/AutowireTest.php	Tests auto-wiring services.
BackendChain	class	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/BackendChain.php	Defines a chained cache implementation for combining multiple cache backends.		2	4
BackendChainImplementationUnitTest	class	Drupal\Tests\Core\Cache	core/tests/Drupal/Tests/Core/Cache/BackendChainImplementationUnitTest.php	Unit test of backend chain implementation specifics.
BackendChainTest	class	Drupal\KernelTests\Core\Cache	core/tests/Drupal/KernelTests/Core/Cache/BackendChainTest.php	Unit test of the backend chain using the generic cache unit test base.
BackendCompilerPass	class	Drupal\Core\DependencyInjection\Compiler	core/lib/Drupal/Core/DependencyInjection/Compiler/BackendCompilerPass.php	Defines a compiler pass to allow automatic override per backend.		2
BackendCompilerPassTest	class	Drupal\Tests\Core\DependencyInjection\Compiler	core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php	@coversDefaultClass \Drupal\Core\DependencyInjection\Compiler\BackendCompilerPass @group DependencyInjection
BackwardCompatibilityTest	class	Drupal\FunctionalJavascriptTests\Ajax	core/tests/Drupal/FunctionalJavascriptTests/Ajax/BackwardCompatibilityTest.php	Tests the compatibility of the ajax.es6.js file.
BadPluginDefinitionException	class	Drupal\migrate\Plugin\Exception	core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php	Defines a class for bad plugin definition exceptions.		4
BaloneySpam	class	Drupal\block_test\Plugin\Condition	core/modules/block/tests/modules/block_test/src/Plugin/Condition/BaloneySpam.php	Provides a 'baloney_spam' condition.
BanAdmin	class	Drupal\ban\Form	core/modules/ban/src/Form/BanAdmin.php	Displays banned IP addresses.			1
Banana	class	Drupal\plugin_test\Plugin\plugin_test\fruit	core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/Banana.php	Plugin annotation @Plugin( id = "banana", label = "Banana", color = "yellow", uses = { "bread" = @Translation("Banana bread"), "loaf" = @PluralTranslation( singular = "@count loaf", plural = "@count loaves" ) } )
BanDelete	class	Drupal\ban\Form	core/modules/ban/src/Form/BanDelete.php	Provides a form to unban IP addresses.			1
BanIpManager	class	Drupal\ban	core/modules/ban/src/BanIpManager.php	Ban IP manager.		1	2
BanIpManagerInterface	interface	Drupal\ban	core/modules/ban/src/BanIpManagerInterface.php	Provides an interface defining a BanIp manager.	1	3
BanMiddleware	class	Drupal\ban	core/modules/ban/src/BanMiddleware.php	Provides a HTTP middleware to implement IP based banning.		1	2
BanMiddlewareTest	class	Drupal\Tests\ban\Unit	core/modules/ban/tests/src/Unit/BanMiddlewareTest.php	@coversDefaultClass \Drupal\ban\BanMiddleware @group ban
Bar	class	Drupal\image_test\Plugin\ImageToolkit\Operation\test	core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/Bar.php	Builds an image toolkit operation.

Pages

Other projects