Classes, traits, and interfaces - 10.3.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 1518

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
AssetControllerBase		abstract class	Drupal\system\Controller	core/modules/system/src/Controller/AssetControllerBase.php	Defines a controller to serve asset aggregates.	2
AssetDumper		class	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AssetDumper.php	Dumps a CSS or JavaScript asset.			3
AssetDumperInterface		interface	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AssetDumperInterface.php	Interface defining a service that dumps an (optimized) asset.	1	1
AssetDumperUriInterface		interface	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AssetDumperUriInterface.php	Interface defining a service that dumps an asset to a specified location.	1	1
AssetGroupSetHashTrait		trait	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AssetGroupSetHashTrait.php	Provides a method to generate a normalized hash of a given asset group set.		3
AssetOptimizationTest		class	Drupal\FunctionalTests\Asset	core/tests/Drupal/FunctionalTests/Asset/AssetOptimizationTest.php	Tests asset aggregation.	1
AssetOptimizationTestUmami		class	Drupal\FunctionalTests\Asset	core/tests/Drupal/FunctionalTests/Asset/AssetOptimizationTestUmami.php	Tests asset aggregation with the Umami install profile.
AssetOptimizerInterface		interface	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AssetOptimizerInterface.php	Interface defining a service that optimizes an asset.	2	2
AssetQueryString		class	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AssetQueryString.php	Stores a cache busting query string service for asset URLs.		2	2
AssetQueryStringInterface		interface	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AssetQueryStringInterface.php	Provides a cache busting query string service for asset URLs.	1	2
AssetQueryStringTest		class	Drupal\KernelTests\Core\Asset	core/tests/Drupal/KernelTests/Core/Asset/AssetQueryStringTest.php	Tests the asset query string functionality.
AssetResolver		class	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AssetResolver.php	The default asset resolver.		1	2
AssetResolverInterface		interface	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AssetResolverInterface.php	Resolves asset libraries into concrete CSS and JavaScript assets.	1	5
AssetResolverTest		class	Drupal\Tests\Core\Asset	core/tests/Drupal/Tests/Core/Asset/AssetResolverTest.php	@coversDefaultClass \Drupal\Core\Asset\AssetResolver[[api-linebreak]] @group Asset
AssetRoutes		class	Drupal\system\Routing	core/modules/system/src/Routing/AssetRoutes.php	Defines a routes' callback to register a URL for serving assets.
AssetsStream		class	Drupal\Core\StreamWrapper	core/lib/Drupal/Core/StreamWrapper/AssetsStream.php	Defines a Drupal stream wrapper class for optimized assets (assets://).		1	2
AssignOwnerNode		class	Drupal\action\Plugin\Action	core/modules/action/src/Plugin/Action/AssignOwnerNode.php	Assigns ownership of a node to a user.	1	1
AssignOwnerNode	in drupal:10.3.0 and is removed from drupal:11.0.0. Use \Drupal\action\Plugin\Action\AssignOwnerNode instead.	class	Drupal\node\Plugin\Action	core/modules/node/src/Plugin/Action/AssignOwnerNode.php	Assigns ownership of a node to a user.		1
AssignOwnerNodeTest		class	Drupal\Tests\node\Unit\Action	core/modules/node/tests/src/Unit/Action/AssignOwnerNodeTest.php	@group node @group legacy
AttachedAssets		class	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AttachedAssets.php	The default attached assets collection.		12
AttachedAssetsInterface		interface	Drupal\Core\Asset	core/lib/Drupal/Core/Asset/AttachedAssetsInterface.php	The attached assets collection for the current response.	1	12
AttachedAssetsTest		class	Drupal\KernelTests\Core\Asset	core/tests/Drupal/KernelTests/Core/Asset/AttachedAssetsTest.php	Tests #attached assets: attached asset libraries and JavaScript settings.
AttachedRenderingBlock		class	Drupal\render_attached_test\Plugin\Block	core/modules/system/tests/modules/render_attached_test/src/Plugin/Block/AttachedRenderingBlock.php	A block we can use to test caching of #attached headers.
Attachment		class	Drupal\views\Plugin\views\display	core/modules/views/src/Plugin/views/display/Attachment.php	The plugin that handles an attachment display.
AttachmentsInterface		interface	Drupal\Core\Render	core/lib/Drupal/Core/Render/AttachmentsInterface.php	The attached metadata collection for a renderable element.	5	11
AttachmentsResponseProcessorInterface		interface	Drupal\Core\Render	core/lib/Drupal/Core/Render/AttachmentsResponseProcessorInterface.php	Defines an interface for processing attachments of responses that have them.	2	4
AttachmentsTestDomainObject		class	Drupal\early_rendering_controller_test	core/modules/system/tests/modules/early_rendering_controller_test/src/AttachmentsTestDomainObject.php
AttachmentsTestResponse		class	Drupal\early_rendering_controller_test	core/modules/system/tests/modules/early_rendering_controller_test/src/AttachmentsTestResponse.php
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	38	11
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
AttributeBase		abstract class	Drupal\Component\Plugin\Attribute	core/lib/Drupal/Component/Plugin/Attribute/AttributeBase.php	Provides a base class for classed attributes.	3	1
AttributeBaseStub		class	Drupal\Tests\Component\Plugin\Attribute	core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeBaseTest.php
AttributeBaseTest		class	Drupal\Tests\Component\Plugin\Attribute	core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeBaseTest.php	@coversDefaultClass \Drupal\Component\Plugin\Attribute\AttributeBase[[api-linebreak]] @group Attribute
AttributeBoolean		class	Drupal\Core\Template	core/lib/Drupal/Core/Template/AttributeBoolean.php	A class that defines a type of boolean HTML attribute.
AttributeBridgeDecorator		class	Drupal\Component\Plugin\Discovery	core/lib/Drupal/Component/Plugin/Discovery/AttributeBridgeDecorator.php	Ensures that all definitions are run through the attribute process.		3
AttributeBridgeDecoratorTest		class	Drupal\Tests\Component\Plugin\Discovery	core/tests/Drupal/Tests/Component/Plugin/Discovery/AttributeBridgeDecoratorTest.php	@coversDefaultClass \Drupal\Component\Annotation\Plugin\Discovery\AnnotationBridgeDecorator[[api-linebreak]] @group Plugin
AttributeClass		final class	Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Attribute	core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Attribute/AttributeClass.php	#[\Attribute]
AttributeClassDiscovery		class	Drupal\Core\Plugin\Discovery	core/lib/Drupal/Core/Plugin/Discovery/AttributeClassDiscovery.php	Defines a discovery mechanism to find plugins using attributes.	1	1
AttributeClassDiscovery		class	Drupal\Component\Plugin\Discovery	core/lib/Drupal/Component/Plugin/Discovery/AttributeClassDiscovery.php	Defines a discovery mechanism to find plugins with attributes.	1	3
AttributeClassDiscoveryCachedTest		class	Drupal\Tests\Component\Plugin\Attribute	core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeClassDiscoveryCachedTest.php	@coversDefaultClass \Drupal\Component\Plugin\Discovery\AttributeClassDiscovery[[api-linebreak]] @group Attribute @runTestsInSeparateProcesses
AttributeClassDiscoveryTest		class	Drupal\Tests\Component\Plugin\Attribute	core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeClassDiscoveryTest.php	@coversDefaultClass \Drupal\Component\Plugin\Discovery\AttributeClassDiscovery[[api-linebreak]] @group Attribute @runTestsInSeparateProcesses
AttributeDiscoveryTest1		class	com\example\PluginNamespace	core/tests/fixtures/plugins/Plugin/PluginNamespace/AttributeDiscoveryTest1.php	Provides a custom test plugin.
AttributeDiscoveryTest2		class	com\example\PluginNamespace	core/tests/fixtures/plugins/Plugin/PluginNamespace/AttributeDiscoveryTest2.php	Provides a custom test plugin that extends from a missing dependency.
AttributeDiscoveryWithAnnotations		class	Drupal\Core\Plugin\Discovery	core/lib/Drupal/Core/Plugin/Discovery/AttributeDiscoveryWithAnnotations.php	Enables both attribute and annotation discovery for plugin definitions.		3
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[[api-linebreak]] @group Template
AttributeInterface		interface	Drupal\Component\Plugin\Attribute	core/lib/Drupal/Component/Plugin/Attribute/AttributeInterface.php	Defines a common interface for classed attributes.	1	4
AttributesTest		class	Drupal\Tests\Core\Common	core/tests/Drupal/Tests/Core/Common/AttributesTest.php	Tests the Drupal\Core\Template\Attribute functionality.

Other projects

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