Classes, traits, and interfaces - 8.9.x - drupal

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 1511

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
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
AutomatedCronUpdateWithAutomatedCronTest		class	Drupal\Tests\system\Functional\Update	core/modules/system/tests/src/Functional/Update/AutomatedCronUpdateWithAutomatedCronTest.php	Ensures that the automated cron module is installed on update.
AutomatedCronUpdateWithoutAutomatedCronTest		class	Drupal\Tests\system\Functional\Update	core/modules/system/tests/src/Functional/Update/AutomatedCronUpdateWithoutAutomatedCronTest.php	Ensures that the automated cron module is not installed on update.
BackendChain		class	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/BackendChain.php	Defines a chained cache implementation for combining multiple cache backends.		2	2
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.
BarClass		class	Drupal\Tests\Core\DependencyInjection\Fixture	core/tests/Drupal/Tests/Core/DependencyInjection/Fixture/BarClass.php	Stub class which acts as a service to test the container.		2
BareHtmlPageRenderer		class	Drupal\Core\Render	core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php	Default bare HTML page renderer.			2
BareHtmlPageRenderer		class	Drupal\Core\ProxyClass\Render	core/lib/Drupal/Core/ProxyClass/Render/BareHtmlPageRenderer.php	Provides a proxy class for \Drupal\Core\Render\BareHtmlPageRenderer.
BareHtmlPageRendererInterface		interface	Drupal\Core\Render	core/lib/Drupal/Core/Render/BareHtmlPageRendererInterface.php	Bare HTML page renderer.	2	2
BartikTest		class	Drupal\FunctionalTests\Theme	core/tests/Drupal/FunctionalTests/Theme/BartikTest.php	Tests the Bartik theme.
BaseCommand		class	Drupal\Core\Ajax	core/lib/Drupal/Core/Ajax/BaseCommand.php	Base command that only exists to simplify AJAX commands.	5	5
BaseFieldAccessTest		class	Drupal\Tests\views\Functional\Entity	core/modules/views/tests/src/Functional/Entity/BaseFieldAccessTest.php	Tests views base field access.
BaseFieldDefinition		class	Drupal\Core\Field	core/lib/Drupal/Core/Field/BaseFieldDefinition.php	A class for defining entity fields.	2	108
BaseFieldDefinitionTest		class	Drupal\Tests\Core\Entity	core/tests/Drupal/Tests/Core/Entity/BaseFieldDefinitionTest.php	Unit test for BaseFieldDefinition.
BaseFieldDefinitionTest		class	Drupal\Tests\migrate\Unit\Plugin\migrate\destination	core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/EntityTestBase.php	Stub class for BaseFieldDefinition.
BaseFieldDefinitionTestBase		abstract class	Drupal\Tests\Core\Field	core/tests/Drupal/Tests/Core/Field/BaseFieldDefinitionTestBase.php	Provides setup method for testing base field definitions.	1	1
BaseFieldFileFormatterBase		abstract class	Drupal\file\Plugin\Field\FieldFormatter	core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php	Base class for file formatters, which allow to link to the file download URL.	4
BaseFieldOverride		class	Drupal\Core\Field\Entity	core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php	Defines the base field override entity.		11
BaseFieldOverrideAccessControlHandler		class	Drupal\Core\Field	core/lib/Drupal/Core/Field/BaseFieldOverrideAccessControlHandler.php	Provides en entity access control handler for base field override entity.
BaseFieldOverrideHalJsonAnonTest		class	Drupal\FunctionalTests\Hal	core/tests/Drupal/FunctionalTests/Hal/BaseFieldOverrideHalJsonAnonTest.php	@group hal
BaseFieldOverrideHalJsonBasicAuthTest		class	Drupal\FunctionalTests\Hal	core/tests/Drupal/FunctionalTests/Hal/BaseFieldOverrideHalJsonBasicAuthTest.php	@group hal
BaseFieldOverrideHalJsonCookieTest		class	Drupal\FunctionalTests\Hal	core/tests/Drupal/FunctionalTests/Hal/BaseFieldOverrideHalJsonCookieTest.php	@group hal
BaseFieldOverrideJsonAnonTest		class	Drupal\FunctionalTests\Rest	core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideJsonAnonTest.php	@group rest
BaseFieldOverrideJsonBasicAuthTest		class	Drupal\FunctionalTests\Rest	core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideJsonBasicAuthTest.php	@group rest
BaseFieldOverrideJsonCookieTest		class	Drupal\FunctionalTests\Rest	core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideJsonCookieTest.php	@group rest
BaseFieldOverrideResourceTestBase		abstract class	Drupal\FunctionalTests\Rest	core/tests/Drupal/FunctionalTests/Rest/BaseFieldOverrideResourceTestBase.php		10	4
BaseFieldOverrideResourceTestBase	in drupal:8.6.0 and is removed from drupal:9.0.0. Use Drupal\FunctionalTests\Rest\BaseFieldOverrideResourceTestBase instead.	abstract class	Drupal\Tests\rest\Functional\EntityResource\BaseFieldOverride	core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideResourceTestBase.php
BaseFieldOverrideStorage		class	Drupal\Core\Field	core/lib/Drupal/Core/Field/BaseFieldOverrideStorage.php	Storage class for base field overrides.
BaseFieldOverrideTest		class	Drupal\KernelTests\Core\Field\Entity	core/tests/Drupal/KernelTests/Core/Field/Entity/BaseFieldOverrideTest.php	@coversDefaultClass \Drupal\Core\Field\Entity\BaseFieldOverride @group Field

Other projects

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