Classes, traits, and interfaces - main - 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 1529

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
DiffFormatter		class	Drupal\Core\Diff	core/lib/Drupal/Core/Diff/DiffFormatter.php	Diff formatter which uses returns output that can be rendered to a table.		1	2
DiffFormatterTest		class	Drupal\Tests\Component\Diff	core/tests/Drupal/Tests/Component/Diff/DiffFormatterTest.php	Test DiffFormatter classes.
DiffOp		class	Drupal\Component\Diff\Engine	core/lib/Drupal/Component/Diff/Engine/DiffOp.php	A diff operation.	4	1
DiffOpAdd		class	Drupal\Component\Diff\Engine	core/lib/Drupal/Component/Diff/Engine/DiffOpAdd.php	A diff operation to add lines.		2
DiffOpChange		class	Drupal\Component\Diff\Engine	core/lib/Drupal/Component/Diff/Engine/DiffOpChange.php	A diff operation to change lines.		2
DiffOpCopy		class	Drupal\Component\Diff\Engine	core/lib/Drupal/Component/Diff/Engine/DiffOpCopy.php	A diff operation to copy lines.		3
DiffOpDelete		class	Drupal\Component\Diff\Engine	core/lib/Drupal/Component/Diff/Engine/DiffOpDelete.php	A diff operation to delete lines.		2
DiffOpOutputBuilder		final class	Drupal\Component\Diff	core/lib/Drupal/Component/Diff/DiffOpOutputBuilder.php	Returns a diff as an array of DiffOp operations.		1
DiffOpOutputBuilderTest		class	Drupal\Tests\Component\Diff	core/tests/Drupal/Tests/Component/Diff/DiffOpOutputBuilderTest.php	Tests Drupal\Component\Diff\DiffOpOutputBuilder.
Dimension		class	Drupal\Core\Theme\Plugin\DesignTokenValue	core/lib/Drupal/Core/Theme/Plugin/DesignTokenValue/Dimension.php	Dimension design token value.		5
DimensionTest		class	Drupal\Tests\Core\Theme\DesignToken\Plugin	core/tests/Drupal/Tests/Core/Theme/DesignToken/Plugin/DimensionTest.php	Tests dimension value plugin.
DimensionUnitInterface		interface	Drupal\Core\Theme\DesignToken\Enum	core/lib/Drupal/Core/Theme/DesignToken/Enum/DimensionUnitInterface.php	Interface for dimension units.		2
DirectoryNotReadyException		class	Drupal\Core\File\Exception	core/lib/Drupal/Core/File/Exception/DirectoryNotReadyException.php	Exception thrown when a file's destination directory is not ready.		3
DirectoryTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/DirectoryTest.php	Tests operations dealing with directories.	1
DirectoryWithMetadataDiscovery		class	Drupal\Core\Plugin\Discovery	core/lib/Drupal/Core/Plugin/Discovery/DirectoryWithMetadataDiscovery.php	Does the actual finding of the directories with metadata files.
DirectoryWithMetadataPluginDiscovery		class	Drupal\Core\Plugin\Discovery	core/lib/Drupal/Core/Plugin/Discovery/DirectoryWithMetadataPluginDiscovery.php	Discover directories that contain a specific metadata file.		1
DirectWritePreconditionBypass		final class	Drupal\package_manager	core/modules/package_manager/src/DirectWritePreconditionBypass.php	Allows certain Composer Stager preconditions to be bypassed.		1	3
DirectWriteSubscriber		final class	Drupal\package_manager\EventSubscriber	core/modules/package_manager/src/EventSubscriber/DirectWriteSubscriber.php	Handles sandbox events when direct-write is enabled.		1
DirectWriteTest		class	Drupal\Tests\package_manager\Kernel	core/modules/package_manager/tests/src/Kernel/DirectWriteTest.php	Tests Direct Write.
DisabledDisplayTest		class	Drupal\Tests\views\Functional\Plugin	core/modules/views/tests/src/Functional/Plugin/DisabledDisplayTest.php	Tests the ability to disable and enable view displays.
DisallowBasicAuthRequests		class	Drupal\basic_auth\PageCache	core/modules/basic_auth/src/PageCache/DisallowBasicAuthRequests.php	Cache policy for pages served from basic auth.			2
DiscardLayoutChangesForm		class	Drupal\layout_builder\Form	core/modules/layout_builder/src/Form/DiscardLayoutChangesForm.php	Discards any pending changes to the layout.		1
DiscardLayoutChangesFormTest		class	Drupal\Tests\layout_builder\Unit	core/modules/layout_builder/tests/src/Unit/DiscardLayoutChangesFormTest.php	Tests the Layout Builder discard layout form.
DiscoverableInterface		interface	Drupal\Component\Discovery	core/lib/Drupal/Component/Discovery/DiscoverableInterface.php	Interface for classes providing a type of discovery.	2
DiscoverServiceProvidersTest		class	Drupal\Tests\Core\DrupalKernel	core/tests/Drupal/Tests/Core/DrupalKernel/DiscoverServiceProvidersTest.php	Tests Drupal\Core\DrupalKernel.
DiscoveryCachedTrait		trait	Drupal\Component\Plugin\Discovery	core/lib/Drupal/Component/Plugin/Discovery/DiscoveryCachedTrait.php	Trait for accessing cached definitions of the plugin discovery component.		2
DiscoveryCachedTraitMockableClass		class	Drupal\Tests\Component\Plugin\Discovery	core/tests/Drupal/Tests/Component/Plugin/Discovery/DiscoveryCachedTraitTest.php	A class using the DiscoveryCachedTrait for mocking purposes.
DiscoveryCachedTraitTest		class	Drupal\Tests\Component\Plugin\Discovery	core/tests/Drupal/Tests/Component/Plugin/Discovery/DiscoveryCachedTraitTest.php	Tests Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait.
DiscoveryException		class	Drupal\Component\Discovery	core/lib/Drupal/Component/Discovery/DiscoveryException.php	Exception thrown during discovery if the data is invalid.		3
DiscoveryInterface		interface	Drupal\Component\Plugin\Discovery	core/lib/Drupal/Component/Plugin/Discovery/DiscoveryInterface.php	Defines the minimum requirements for a plugin discovery component.	18	32
DiscoveryTest1		class	com\example\PluginNamespace	core/tests/Drupal/Tests/Component/Annotation/Fixtures/PluginNamespace/DiscoveryTest1.php	Provides a custom test plugin.
DiscoveryTestBase		abstract class	Drupal\KernelTests\Core\Plugin\Discovery	core/tests/Drupal/KernelTests/Core/Plugin/Discovery/DiscoveryTestBase.php	Base class for plugin discovery tests.	4
DiscoveryTrait		trait	Drupal\Component\Plugin\Discovery	core/lib/Drupal/Component/Plugin/Discovery/DiscoveryTrait.php			12
DiscoveryTraitMockableClass		class	Drupal\Tests\Component\Plugin\Discovery	core/tests/Drupal/Tests/Component/Plugin/Discovery/DiscoveryTraitTest.php	A class using the DiscoveryTrait for mocking purposes.
DiscoveryTraitTest		class	Drupal\Tests\Component\Plugin\Discovery	core/tests/Drupal/Tests/Component/Plugin/Discovery/DiscoveryTraitTest.php	Tests Drupal\Component\Plugin\Discovery\DiscoveryTrait.
DiskSpaceValidator		class	Drupal\package_manager\Validator	core/modules/package_manager/src/Validator/DiskSpaceValidator.php	Validates that there is enough free disk space to do stage operations.	1	2
DiskSpaceValidatorTest		class	Drupal\Tests\package_manager\Kernel	core/modules/package_manager/tests/src/Kernel/DiskSpaceValidatorTest.php	Tests Disk Space Validator.
Display		class	Drupal\views_ui\Form\Ajax	core/modules/views_ui/src/Form/Ajax/Display.php	Provides a form for editing the Views display.
DisplayApiTest		class	Drupal\Tests\field\Kernel	core/modules/field/tests/src/Kernel/DisplayApiTest.php	Tests the field display API.
DisplayAttachmentTest		class	Drupal\Tests\views\Functional\Plugin	core/modules/views/tests/src/Functional/Plugin/DisplayAttachmentTest.php	Tests the attachment display plugin.
DisplayAttachmentTest		class	Drupal\Tests\views_ui\Functional	core/modules/views_ui/tests/src/Functional/DisplayAttachmentTest.php	Tests the UI for the attachment display plugin.
DisplayBlockTest		class	Drupal\Tests\block\Functional\Views	core/modules/block/tests/src/Functional/Views/DisplayBlockTest.php	Tests the block display plugin.
DisplayCRUDTest		class	Drupal\Tests\views_ui\Functional	core/modules/views_ui/tests/src/Functional/DisplayCRUDTest.php	Tests creation, retrieval, updating, and deletion of displays in the Web UI.
DisplayEntityReferenceTest		class	Drupal\Tests\views\Functional\Plugin	core/modules/views/tests/src/Functional/Plugin/DisplayEntityReferenceTest.php	Tests the entity reference display plugin.
DisplayExtenderPluginBase		abstract class	Drupal\views\Plugin\views\display_extender	core/modules/views/src/Plugin/views/display_extender/DisplayExtenderPluginBase.php	Base class for Views display extender plugins.	2	1
DisplayExtenderTest		class	Drupal\Tests\views\Kernel\Plugin	core/modules/views/tests/src/Kernel/Plugin/DisplayExtenderTest.php	Tests the display extender plugins.
DisplayExtenderTest		class	Drupal\views_test_data\Plugin\views\display_extender	core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest.php	Defines a display extender test plugin.	2	1
DisplayExtenderTest2		class	Drupal\views_test_data\Plugin\views\display_extender	core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest2.php	Defines another display extender test plugin.
DisplayExtenderTest3		class	Drupal\views_test_data\Plugin\views\display_extender	core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest3.php	Defines the third display extender test plugin.
DisplayExtenderUITest		class	Drupal\Tests\views_ui\Functional	core/modules/views_ui/tests/src/Functional/DisplayExtenderUITest.php	Tests the display extender UI.

Other projects

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