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
Event class Drupal\Component\EventDispatcher core/lib/Drupal/Component/EventDispatcher/Event.php Provides a forward-compatibility layer for the Symfony 5 event class. 31 34
EventBase class Drupal\migrate\Event core/modules/migrate/src/Event/EventBase.php Base class for migration events. 2 2
EventBaseTest class Drupal\Tests\migrate\Unit\Event core/modules/migrate/tests/src/Unit/Event/EventBaseTest.php Tests Drupal\migrate\Event\EventBase. 2
EventException class Drupal\Core\Database\Exception core/lib/Drupal/Core/Database/Exception/EventException.php Exception thrown by the database event API. 2
EventLogSubscriber final class Drupal\package_manager_test_event_logger\EventSubscriber core/modules/package_manager/tests/modules/package_manager_test_event_logger/src/EventSubscriber/EventLogSubscriber.php Defines an event subscriber to test logging during events in Package Manager. 1 2
EventSubscriber class Drupal\config_collection_install_test core/modules/config/tests/config_collection_install_test/src/EventSubscriber.php Event subscriber for testing configuration collection. 2
EventSubscriber class Drupal\config_events_test core/modules/config/tests/config_events_test/src/EventSubscriber.php Event subscriber for testing configuration events. 2
EventSubscriber class Drupal\config_transformer_test core/modules/config/tests/config_transformer_test/src/EventSubscriber.php Class EventSubscriber. 2
EventSubscriber class Drupal\config_import_test core/modules/config/tests/config_import_test/src/EventSubscriber.php Config import subscriber for config import events. 2
EventSubscriber class Drupal\language_events_test core/modules/language/tests/language_events_test/src/EventSubscriber.php Event subscriber for testing Language events. 2
EventSubscriber class Drupal\module_install_class_loader_test1 core/modules/system/tests/modules/module_install_class_loader_test1/src/EventSubscriber.php Defines an event subscriber that conditionally unsets the event list. 2
EventSubscriber class Drupal\module_install_class_loader_test2 core/modules/system/tests/modules/module_install_class_loader_test2/src/EventSubscriber.php An event subscriber that does nothing. 2
EventWithPackageListTrait trait Drupal\package_manager\Event core/modules/package_manager/src/Event/EventWithPackageListTrait.php Common methods for pre- and post-require events. 1
EventWithPackageListTraitTest class Drupal\Tests\package_manager\Unit core/modules/package_manager/tests/src/Unit/EventWithPackageListTraitTest.php Tests Event With Package List Trait.
Example1 class Drupal\plugin_test\Plugin\plugin_test\custom_annotation core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/custom_annotation/Example1.php Provides a test plugin with a custom annotation.
Example2 class Drupal\plugin_test\Plugin\plugin_test\custom_annotation core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/custom_annotation/Example2.php Provides a test plugin with a custom annotation.
Example3 class Drupal\plugin_test\Plugin\plugin_test\custom_annotation core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/custom_annotation/Example3.php Provides a test plugin with a custom attribute.
Example4 class Drupal\plugin_test\Plugin\plugin_test\custom_annotation core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/custom_annotation/Example4.php Provides a test plugin with a custom attribute.
Example5 class Drupal\plugin_test\Plugin\plugin_test\custom_annotation core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/custom_annotation/Example5.php Provides a test plugin with a custom attribute.
ExampleAttribute final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures\ExtraAttributes core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/ExtraAttributes/ExampleAttribute.php #[\Attribute] 2
ExampleParentAttribute class Drupal\Tests\Component\Annotation\Doctrine\Fixtures\ExtraAttributes core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/ExtraAttributes/ExampleParentAttribute.php #[\Attribute] 1
ExampleRenderable class Drupal\twig_theme_test core/modules/system/tests/modules/twig_theme_test/src/ExampleRenderable.php Provides an example implementation of the RenderableInterface.
ExampleWithAttributeAndAnnotation class Drupal\plugin_test\Plugin\plugin_test\custom_annotation core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/custom_annotation/ExampleWithAttributeAndAnnotation.php Provides a test plugin with an annotation and attribute.
ExampleWithOtherModuleDependency class Drupal\plugin_test\Plugin\plugin_test\custom_annotation core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/custom_annotation/ExampleWithOtherModuleDependency.php Test class with a dependency on another module.
ExceptionContainer class Drupal\FunctionalTests\Bootstrap core/tests/Drupal/FunctionalTests/Bootstrap/ExceptionContainer.php Base container which throws an exception.
ExceptionDetectNeedsInstallSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/ExceptionDetectNeedsInstallSubscriber.php Exception handler to determine if an exception indicates an uninstalled site. 2
ExceptionHandler class Drupal\Core\Database core/lib/Drupal/Core/Database/ExceptionHandler.php Base Database exception handler class. 2 6
ExceptionHandler class Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/ExceptionHandler.php CoreFakeWithAllCustomClasses implementation of \Drupal\Core\Database\ExceptionHandler.
ExceptionHandler class Drupal\mysqli\Driver\Database\mysqli core/modules/mysqli/src/Driver/Database/mysqli/ExceptionHandler.php MySQLi database exception handler class.
ExceptionHandler class Drupal\mysql\Driver\Database\mysql core/modules/mysql/src/Driver/Database/mysql/ExceptionHandler.php MySql database exception handler class. 1 1
ExceptionHandlingTest class Drupal\KernelTests\Core\Routing core/tests/Drupal/KernelTests/Core/Routing/ExceptionHandlingTest.php Tests the exception handling for various cases.
ExceptionInterface interface Drupal\Component\Plugin\Exception core/lib/Drupal/Component/Plugin/Exception/ExceptionInterface.php Exception interface for all exceptions thrown by the Plugin component. 5 2
ExceptionJsonSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/ExceptionJsonSubscriber.php Default handling for JSON errors. 1 2
ExceptionJsonSubscriberTest class Drupal\Tests\Core\EventSubscriber core/tests/Drupal/Tests/Core/EventSubscriber/ExceptionJsonSubscriberTest.php Tests Drupal\Core\EventSubscriber\ExceptionJsonSubscriber.
ExceptionLoggingSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/ExceptionLoggingSubscriber.php Log exceptions without further handling. 2
ExceptionLoggingSubscriberTest class Drupal\KernelTests\Core\EventSubscriber core/tests/Drupal/KernelTests/Core/EventSubscriber/ExceptionLoggingSubscriberTest.php Tests that HTTP exceptions are logged correctly.
ExceptionStatusCodeCacheContext class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/ExceptionStatusCodeCacheContext.php Defines the ExceptionStatusCodeCacheContext service. 1 2
ExceptionStatusCodeCacheContextTest class Drupal\Tests\Core\Cache\Context core/tests/Drupal/Tests/Core/Cache/Context/ExceptionStatusCodeCacheContextTest.php Tests Drupal\Core\Cache\Context\CookiesCacheContext.
ExcludedFieldTokenTest class Drupal\Tests\rest\Functional\Views core/modules/rest/tests/src/Functional/Views/ExcludedFieldTokenTest.php Tests the display of an excluded field that is used as a token.
ExcludedModulesEventSubscriber final class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/ExcludedModulesEventSubscriber.php The event subscriber preventing excluded modules to be exported. 2
ExcludedModulesEventSubscriberTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/ExcludedModulesEventSubscriberTest.php Tests ExcludedModulesEventSubscriber.
ExecTrait trait Drupal\Tests\Composer\Plugin core/tests/Drupal/Tests/Composer/Plugin/ExecTrait.php Convenience class for creating fixtures. 5
ExecutableException class Drupal\Core\Executable core/lib/Drupal/Core/Executable/ExecutableException.php Generic executable plugin exception class. 1
ExecutableFinder final class Drupal\package_manager core/modules/package_manager/src/ExecutableFinder.php An executable finder which looks for executable paths in configuration. 2
ExecutableFinderTest class Drupal\Tests\package_manager\Unit core/modules/package_manager/tests/src/Unit/ExecutableFinderTest.php Tests Package Manager's executable finder service.
ExecutableInterface interface Drupal\Core\Executable core/lib/Drupal/Core/Executable/ExecutableInterface.php An interface for executable plugins. 3 3
ExecutableManagerInterface interface Drupal\Core\Executable core/lib/Drupal/Core/Executable/ExecutableManagerInterface.php An interface for managers of executable plugins. 1 6
ExecutablePluginBase abstract class Drupal\Core\Executable core/lib/Drupal/Core/Executable/ExecutablePluginBase.php Provides the basic architecture for executable plugins. 1 1
ExecuteMigration class Drupal\migrate_no_migrate_drupal_test\Controller core/modules/migrate/tests/modules/migrate_no_migrate_drupal_test/src/Controller/ExecuteMigration.php Custom controller to execute the test migrations.
ExecutionContext class Drupal\Core\Validation core/lib/Drupal/Core/Validation/ExecutionContext.php Defines an execution context class. 2

Other projects

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