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
DenyPrivateImageStyleDownloadTest		class	Drupal\Tests\image\Unit\PageCache	core/modules/image/tests/src/Unit/PageCache/DenyPrivateImageStyleDownloadTest.php	@coversDefaultClass \Drupal\image\PageCache\DenyPrivateImageStyleDownload[[api-linebreak]] @group image
DenyTestAuthRequests		class	Drupal\rest_test\PageCache\RequestPolicy	core/modules/rest/tests/modules/rest_test/src/PageCache/RequestPolicy/DenyTestAuthRequests.php	Cache policy for pages requested with REST Test Auth.			2
Dependency		class	Drupal\Core\Extension	core/lib/Drupal/Core/Extension/Dependency.php	A value object representing dependency information.		4
DependencyFieldItem		class	Drupal\Tests\field\Unit	core/modules/field/tests/src/Unit/FieldConfigEntityUnitTest.php	A test class.
DependencyHookInvocationTest		class	Drupal\Tests\system\Functional\UpdateSystem	core/modules/system/tests/src/Functional/UpdateSystem/DependencyHookInvocationTest.php	Tests the hook invocation for determining update dependencies.
DependencyMissingTest		class	Drupal\Tests\system\Functional\UpdateSystem	core/modules/system/tests/src/Functional/UpdateSystem/DependencyMissingTest.php	Tests that missing update dependencies are correctly flagged.
DependencyOrderingTest		class	Drupal\Tests\system\Functional\UpdateSystem	core/modules/system/tests/src/Functional/UpdateSystem/DependencyOrderingTest.php	Tests that update functions are run in the proper order.
DependencySerializationTest		class	Drupal\Tests\Core\DependencyInjection	core/tests/Drupal/Tests/Core/DependencyInjection/DependencySerializationTest.php	@coversDefaultClass \Drupal\Core\DependencyInjection\DependencySerializationTrait[[api-linebreak]] @group DependencyInjection
DependencySerializationTestDummy		class	Drupal\Tests\Core\DependencyInjection	core/tests/Drupal/Tests/Core/DependencyInjection/DependencySerializationTest.php	Defines a test class which has a single service as dependency.
DependencySerializationTrait		trait	Drupal\Core\DependencyInjection	core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php	Provides dependency injection friendly methods for serialization.		52
DependencySerializationTraitPass	in drupal:9.5.0 and is removed from drupal:11.0.0. The _serviceId property is no longer part of the container. Use \Drupal\Core\DrupalKernelInterface::getServiceIdMapping() instead.	class	Drupal\Core\DependencyInjection\Compiler	core/lib/Drupal/Core/DependencyInjection/Compiler/DependencySerializationTraitPass.php	Sets the _serviceId property on all services.
DependencyTest		class	Drupal\Tests\Core\Extension	core/tests/Drupal/Tests/Core/Extension/DependencyTest.php	@coversDefaultClass \Drupal\Core\Extension\Dependency[[api-linebreak]] @group Extension
DependencyTest		class	Drupal\Tests\system\Functional\Module	core/modules/system/tests/src/Functional/Module/DependencyTest.php	Enable module without dependency enabled.
DependencyTest		class	Drupal\Tests\forum\Functional\Module	core/modules/forum/tests/src/Functional/Module/DependencyTest.php	Enable module without dependency enabled.
DependencyTrait		trait	Drupal\Core\Entity	core/lib/Drupal/Core/Entity/DependencyTrait.php	Provides a trait for managing an object's dependencies.		6
DependentAccessInterface		interface	Drupal\block_content\Access	core/modules/block_content/src/Access/DependentAccessInterface.php	Interface for AccessibleInterface objects that have an access dependency.	1	1
DependentAccessTest		class	Drupal\Tests\block_content\Unit\Access	core/modules/block_content/tests/src/Unit/Access/DependentAccessTest.php	@coversDefaultClass \Drupal\block_content\Access\RefinableDependentAccessTrait[[api-linebreak]]
DependentPluginDefinitionInterface		interface	Drupal\Core\Plugin\Definition	core/lib/Drupal/Core/Plugin/Definition/DependentPluginDefinitionInterface.php	Provides an interface for a plugin definition that has dependencies.	1	3
DependentPluginDefinitionTrait		trait	Drupal\Core\Plugin\Definition	core/lib/Drupal/Core/Plugin/Definition/DependentPluginDefinitionTrait.php	Provides a trait for a plugin definition that has dependencies.		1
DependentPluginInterface		interface	Drupal\Component\Plugin	core/lib/Drupal/Component/Plugin/DependentPluginInterface.php	Provides an interface for a plugin that has dependencies.	23	27
DependentWithRemovalPluginInterface		interface	Drupal\views\Plugin	core/modules/views/src/Plugin/DependentWithRemovalPluginInterface.php	Provides an interface for a plugin that has dependencies that can be removed.	2	3
Deprecated		class	Drupal\element_info_test\Element	core/modules/system/tests/modules/element_info_test/src/Element/Deprecated.php	Provides deprecated render element for testing.
DeprecatedArray		class	Drupal\Component\Utility	core/lib/Drupal/Component/Utility/DeprecatedArray.php	An array that triggers a deprecation warning when accessed.
DeprecatedAssetsTest		class	Drupal\KernelTests\Core\Asset	core/tests/Drupal/KernelTests/Core/Asset/DeprecatedAssetsTest.php	Checks the status and definition contents of deprecated libraries.
DeprecatedController		class	Drupal\deprecation_test	core/modules/system/tests/modules/deprecation_test/src/DeprecatedController.php	Defines a controller that calls a deprecated method.
DeprecatedElementTest		class	Drupal\KernelTests\Core\Render\Element	core/tests/Drupal/KernelTests/Core/Render/Element/DeprecatedElementTest.php	@group Render
DeprecatedExtendsFormElement		class	Drupal\element_info_test\Element	core/modules/system/tests/modules/element_info_test/src/Element/DeprecatedExtendsFormElement.php	Provides render element that extends deprecated FormElement for testing.		1
DeprecatedExtendsRenderElement		class	Drupal\element_info_test\Element	core/modules/system/tests/modules/element_info_test/src/Element/DeprecatedExtendsRenderElement.php	Provides render element that extends deprecated RenderElement for testing.		1
DeprecatedReferenceItem		class	Drupal\jsonapi_test_reference_types\Plugin\Field\FieldType	core/modules/jsonapi/tests/modules/jsonapi_test_reference_types/src/Plugin/Field/FieldType/DeprecatedReferenceItem.php	Entity reference field type which doesn't implement the standard interface.
DeprecatedServicePass		class	Drupal\Core\DependencyInjection\Compiler	core/lib/Drupal/Core/DependencyInjection/Compiler/DeprecatedServicePass.php	Sets the _deprecated_service_list parameter.		1
DeprecatedServicePropertyTrait		trait	Drupal\Core\DependencyInjection	core/lib/Drupal/Core/DependencyInjection/DeprecatedServicePropertyTrait.php	Provides a standard way to announce deprecated properties.		14
DeprecatedTemplateTest		class	Drupal\Tests\system\Functional\Module	core/modules/system/tests/src/Functional/Module/DeprecatedTemplateTest.php	Tests that the deprecated template is correctly marked.
DeprecatedTwigTemplateController		class	Drupal\deprecated_twig_template\Controller	core/modules/system/tests/modules/deprecated_twig_template/src/Controller/DeprecatedTwigTemplateController.php	Controller for calling a deprecated theme.
DeprecationHelper		final class	Drupal\Component\Utility	core/lib/Drupal/Component/Utility/DeprecationHelper.php	Provides a helper method for handling deprecated code paths in projects.		1
DeprecationHelperTest		class	Drupal\Tests\Component\Utility	core/tests/Drupal/Tests/Component/Utility/DeprecationHelperTest.php	@coversDefaultClass \Drupal\Component\Utility\DeprecationHelper[[api-linebreak]] @group Utility
Depth		class	Drupal\comment\Plugin\views\field	core/modules/comment/src/Plugin/views/field/Depth.php	Field handler to display the depth of a comment.
DerivablePluginDefinitionInterface		interface	Drupal\Component\Plugin\Definition	core/lib/Drupal/Component/Plugin/Definition/DerivablePluginDefinitionInterface.php	Provides an interface for a derivable plugin definition.	2	4
DerivativeDiscoveryDecorator		class	Drupal\Component\Plugin\Discovery	core/lib/Drupal/Component/Plugin/Discovery/DerivativeDiscoveryDecorator.php	Base class providing the tools for a plugin discovery to be derivative aware.	1	3
DerivativeDiscoveryDecoratorTest		class	Drupal\Tests\Core\Plugin\Discovery	core/tests/Drupal/Tests/Core/Plugin/Discovery/DerivativeDiscoveryDecoratorTest.php	Unit tests for the derivative discovery decorator.
DerivativeInspectionInterface		interface	Drupal\Component\Plugin	core/lib/Drupal/Component/Plugin/DerivativeInspectionInterface.php	Provides a plugin interface for providing derivative metadata inspection.	8	11
DerivativeTest		class	Drupal\KernelTests\Core\Plugin	core/tests/Drupal/KernelTests/Core/Plugin/DerivativeTest.php	Tests that derivative plugins are correctly discovered.
DerivedToolkit		class	Drupal\image_test\Plugin\ImageToolkit	core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/DerivedToolkit.php	Provides a derivative of TestToolkit.
DeriverBase		abstract class	Drupal\Component\Plugin\Derivative	core/lib/Drupal/Component/Plugin/Derivative/DeriverBase.php	Provides a basic deriver.	48	48
DeriverInterface		interface	Drupal\Component\Plugin\Derivative	core/lib/Drupal/Component/Plugin/Derivative/DeriverInterface.php	Provides additional plugin definitions based on an existing definition.	7	6
Desaturate		class	Drupal\system\Plugin\ImageToolkit\Operation\gd	core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php	Defines GD2 Desaturate operation.
DesaturateImageEffect		class	Drupal\image\Plugin\ImageEffect	core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php	Desaturates (grayscale) an image resource.
DescriptionAwareFileFormatterBase		abstract class	Drupal\file\Plugin\Field\FieldFormatter	core/modules/file/src/Plugin/Field/FieldFormatter/DescriptionAwareFileFormatterBase.php	Base class for file formatters that have to deal with file descriptions.	2
DestinationBase		abstract class	Drupal\migrate\Plugin\migrate\destination	core/modules/migrate/src/Plugin/migrate/destination/DestinationBase.php	Base class for migrate destination classes.	10	6
DestinationCategoryTest		class	Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate	core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/DestinationCategoryTest.php	Tests that all migrations are tagged as either content or configuration.
DestinationTest		class	Drupal\Tests\system\Functional\Routing	core/modules/system/tests/src/Functional/Routing/DestinationTest.php	Tests for $_GET['destination'] and $_REQUEST['destination'] validation.

Other projects

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