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
DriverSpecificSyntaxTestBase abstract class Drupal\KernelTests\Core\Database core/tests/Drupal/KernelTests/Core/Database/DriverSpecificSyntaxTestBase.php Tests driver specific SQL syntax interpretation. 4 4
DriverSpecificTransactionTestBase abstract class Drupal\KernelTests\Core\Database core/tests/Drupal/KernelTests/Core/Database/DriverSpecificTransactionTestBase.php Tests the transaction abstraction system. 4 4
Dropbutton class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Dropbutton.php Provides a render element for a set of links rendered as a drop-down button. 1
Dropbutton class Drupal\views\Plugin\views\field core/modules/views/src/Plugin/views/field/Dropbutton.php Provides a handler that renders links as dropbutton.
Drupal class core/lib/Drupal.php Static Service Container wrapper.
Drupal6SqlBaseTest class Drupal\Tests\migrate_drupal\Unit\source\d6 core/modules/migrate_drupal/tests/src/Unit/source/d6/Drupal6SqlBaseTest.php Tests the D6 SQL base class.
DrupalApplication class Drupal\Core\Command core/lib/Drupal/Core/Command/DrupalApplication.php Customize the Symfony Application for Drupal.
DrupalApplicationTesterTrait trait Drupal\KernelTests core/tests/Drupal/KernelTests/DrupalApplicationTesterTrait.php Trait to help with testing the drupal console. 2
DrupalAspectsOfCKEditor5Plugin class Drupal\ckeditor5\Attribute core/modules/ckeditor5/src/Attribute/DrupalAspectsOfCKEditor5Plugin.php Define a Drupal aspects of CKEditor5 plugin.
DrupalAspectsOfCKEditor5Plugin class Drupal\ckeditor5\Annotation core/modules/ckeditor5/src/Annotation/DrupalAspectsOfCKEditor5Plugin.php Defines the "Drupal aspects of a CKEditor5Plugin" annotation object. 1
DrupalComponentTest class Drupal\Tests\Component core/tests/Drupal/Tests/Component/DrupalComponentTest.php General tests for \Drupal\Component that can't go anywhere else.
DrupalConsoleLogger class Drupal\Core\Command core/lib/Drupal/Core/Command/DrupalConsoleLogger.php Logs to the console. A logger is set during DrupalApplication->bootstrap(). 2 2
DrupalConsoleLoggerTest class Drupal\Tests\Core\Command core/tests/Drupal/Tests/Core/Command/DrupalConsoleLoggerTest.php Tests DrupalConsoleLogger.
DrupalCoreComposer class Drupal\Composer\Generator\Util composer/Generator/Util/DrupalCoreComposer.php Utilities for working with drupal composer.json files and data. 6
DrupalCoreRecommendedBuilder class Drupal\Composer\Generator\Builder composer/Generator/Builder/DrupalCoreRecommendedBuilder.php Builder to produce metapackage for drupal/core-recommended. 3
DrupalDateTime class Drupal\Core\Datetime core/lib/Drupal/Core/Datetime/DrupalDateTime.php Extends DateTimePlus(). 3 39
DrupalDateTimeTest class Drupal\Tests\Core\Datetime core/tests/Drupal/Tests/Core/Datetime/DrupalDateTimeTest.php Tests Drupal\Core\Datetime\DrupalDateTime.
DrupalDateTimeTest class Drupal\KernelTests\Core\Datetime core/tests/Drupal/KernelTests/Core/Datetime/DrupalDateTimeTest.php Tests DrupalDateTime functionality.
DrupalDebugClassLoader class Drupal\TestTools\ErrorHandler core/tests/Drupal/TestTools/ErrorHandler/DrupalDebugClassLoader.php Extends Symfony's DebugClassLoader for Drupal-aware vendor boundaries. 2
DrupalDebugClassLoaderTest class Drupal\Tests\TestTools\ErrorHandler core/tests/Drupal/Tests/TestTools/ErrorHandler/DrupalDebugClassLoaderTest.php Tests the DrupalDebugClassLoader.
DrupalDevDependenciesBuilder class Drupal\Composer\Generator\Builder composer/Generator/Builder/DrupalDevDependenciesBuilder.php Builder to produce metapackage for drupal/core-dev. 3
DrupalFlushAllCachesInInstallerTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/DrupalFlushAllCachesInInstallerTest.php Tests drupal_flush_all_caches() and container rebuilds during an install.
DrupalFlushAllCachesTest class Drupal\KernelTests\Core\Common core/tests/Drupal/KernelTests/Core/Common/DrupalFlushAllCachesTest.php Tests Drupal Flush All Caches.
DrupalInstalledTemplate class Drupal\Composer\Plugin\Scaffold composer/Plugin/Scaffold/DrupalInstalledTemplate.php Produces code for the DrupalInstalled file.
DrupalInstalledTest class Drupal\Tests\Composer\Plugin\Scaffold\Functional core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Functional/DrupalInstalledTest.php Tests DrupalInstalled.php hash changes when scaffolding is run.
DrupalKernel class Drupal\Core core/lib/Drupal/Core/DrupalKernel.php The DrupalKernel class is the core of Drupal itself. 4 38
DrupalKernelInterface interface Drupal\Core core/lib/Drupal/Core/DrupalKernelInterface.php The interface for DrupalKernel, the core of Drupal. 1 13
DrupalKernelRequestStackTest class Drupal\KernelTests\Core\DrupalKernel core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelRequestStackTest.php Tests the usage of the request stack as part of request processing.
DrupalKernelSiteTest class Drupal\KernelTests\Core\DrupalKernel core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelSiteTest.php Tests site-specific service overrides.
DrupalKernelTest class Drupal\KernelTests\Core\DrupalKernel core/tests/Drupal/KernelTests/Core/DrupalKernel/DrupalKernelTest.php Tests DIC compilation to disk.
DrupalKernelTest class Drupal\Tests\Core\DrupalKernel core/tests/Drupal/Tests/Core/DrupalKernel/DrupalKernelTest.php Tests Drupal\Core\DrupalKernel.
DrupalLogErrorTest class Drupal\Tests\Core\Error core/tests/Drupal/Tests/Core/Error/DrupalLogErrorTest.php Tests logging of errors in core/error.inc.
DrupalMessengerServiceTest class Drupal\Tests\system\Functional\Bootstrap core/modules/system/tests/src/Functional/Bootstrap/DrupalMessengerServiceTest.php Tests the Messenger service.
DrupalPackageBuilder abstract class Drupal\Composer\Generator\Builder composer/Generator/Builder/DrupalPackageBuilder.php Base class that includes helpful utility routine for Drupal builder classes. 3
DrupalPinnedDevDependenciesBuilder

in drupal:11.4.0 and is removed from drupal:12.0.0. Use drupal/core-dev instead.

 class Drupal\Composer\Generator\Builder composer/Generator/Builder/DrupalPinnedDevDependenciesBuilder.php Builder to produce metapackage for drupal/core-dev-pinned.
DrupalRuntime class Drupal\Core\Runtime core/lib/Drupal/Core/Runtime/DrupalRuntime.php The custom Drupal framework runtime. 1
DrupalSelenium2Driver class Drupal\FunctionalJavascriptTests core/tests/Drupal/FunctionalJavascriptTests/DrupalSelenium2Driver.php Provides a driver for Selenium testing. 1
DrupalSelenium2DriverTest class Drupal\FunctionalJavascriptTests\Tests core/tests/Drupal/FunctionalJavascriptTests/Tests/DrupalSelenium2DriverTest.php Tests the DrupalSelenium2Driver methods.
DrupalSqlBase

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

 abstract class Drupal\migrate_drupal\Plugin\migrate\source core/modules/migrate_drupal/src/Plugin/migrate/source/DrupalSqlBase.php A base class for source plugins using a Drupal database as a source. 65 63
DrupalSqlBaseTest class Drupal\Tests\migrate_drupal\Unit\source core/modules/migrate_drupal/tests/src/Unit/source/DrupalSqlBaseTest.php Tests Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase.
DrupalStandardsListenerDeprecatedClass class Drupal\deprecation_test\Deprecation core/modules/system/tests/modules/deprecation_test/src/Deprecation/DrupalStandardsListenerDeprecatedClass.php Fixture class for use by DrupalStandardsListenerDeprecationTest. 1
DrupalStandardsListenerDeprecationTest class Drupal\Tests\Core\Listeners core/tests/Drupal/Tests/Core/Listeners/DrupalStandardsListenerDeprecationTest.php Test deprecation error handling by DrupalStandardsListener.
DrupalTest class Drupal\Tests\Core core/tests/Drupal/Tests/Core/DrupalTest.php Tests the Drupal class.
DrupalTestBrowser class Drupal\Tests core/tests/Drupal/Tests/DrupalTestBrowser.php Enables a BrowserKitDriver mink driver to use a Guzzle client. 2
DrupalTestCase abstract class Drupal\Tests core/tests/Drupal/Tests/DrupalTestCase.php Provides the root base class for all Drupal core tests. 4 3
DrupalTestCaseTrait trait Drupal\Tests core/tests/Drupal/Tests/DrupalTestCaseTrait.php Provides methods common across Drupal test classes.
DrupalTranslator class Drupal\Core\Validation core/lib/Drupal/Core/Validation/DrupalTranslator.php Translates strings using Drupal's translation system. 2
DtcgInterface interface Drupal\Core\Theme\DesignToken core/lib/Drupal/Core/Theme/DesignToken/DtcgInterface.php Interface for DTCG tokens and groups. 2 1
DummyAjaxFormatter class Drupal\image_module_test\Plugin\Field\FieldFormatter core/modules/image/tests/modules/image_module_test/src/Plugin/Field/FieldFormatter/DummyAjaxFormatter.php Empty renderer for a dummy field with an AJAX handler.
DummyAjaxItem class Drupal\image_module_test\Plugin\Field\FieldType core/modules/image/tests/modules/image_module_test/src/Plugin/Field/FieldType/DummyAjaxItem.php Defines a dummy field containing an AJAX handler.

Other projects

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