Classes, traits, and interfaces - 9.5.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 1523

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
ContextAwarePluginTrait trait Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/ContextAwarePluginTrait.php Provides a trait to add context-aware functionality to plugins. 10
ContextAwarePluginTraitTest class Drupal\KernelTests\Core\Plugin\Context core/tests/Drupal/KernelTests/Core/Plugin/Context/ContextAwarePluginTraitTest.php @coversDefaultClass \Drupal\Core\Plugin\ContextAwarePluginTrait
ContextAwareVariantInterface interface Drupal\Core\Display core/lib/Drupal/Core/Display/ContextAwareVariantInterface.php Provides an interface for variant plugins that are context-aware. 1 2
ContextCacheKeys class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/ContextCacheKeys.php A value object to store generated cache keys with its cacheability metadata. 1
ContextDefinition class Drupal\Core\Annotation core/lib/Drupal/Core/Annotation/ContextDefinition.php Defines a context definition annotation object.
ContextDefinition class Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextDefinition.php Defines a class for context definitions. 2 35
ContextDefinitionInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextDefinitionInterface.php Interface to define definition objects in ContextInterface via TypedData. 1 1
ContextDefinitionInterface interface Drupal\Component\Plugin\Context core/lib/Drupal/Component/Plugin/Context/ContextDefinitionInterface.php Interface used to define definition objects found in ContextInterface. 1 3
ContextDefinitionIsSatisfiedTest class Drupal\Tests\Core\Plugin\Context core/tests/Drupal/Tests/Core/Plugin/Context/ContextDefinitionIsSatisfiedTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\ContextDefinition @group Plugin
ContextDefinitionTest class Drupal\Tests\Core\Plugin\Context core/tests/Drupal/Tests/Core/Plugin/Context/ContextDefinitionTest.php Tests the ContextDefinition class.
ContextDefinitionTest class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/ContextDefinitionTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\ContextDefinition @group Plugin
ContextDefinitionTest class Drupal\KernelTests\Core\Plugin\Annotation core/tests/Drupal/KernelTests/Core/Plugin/Annotation/ContextDefinitionTest.php @coversDefaultClass \Drupal\Core\Annotation\ContextDefinition @group Plugin
ContextException class Drupal\Component\Plugin\Exception core/lib/Drupal/Component/Plugin/Exception/ContextException.php An exception class to be thrown for context plugin exceptions. 1 15
ContextHandler class Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextHandler.php Provides methods to handle sets of contexts. 2 2
ContextHandlerInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextHandlerInterface.php Provides an interface for handling sets of contexts. 1 8
ContextHandlerTest class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/ContextHandlerTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\ContextHandler
ContextHandlerTest class Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/ContextHandlerTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\ContextHandler @group Plugin
ContextInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextInterface.php Context data and definitions for plugins supporting caching and return docs. 1 3
ContextInterface interface Drupal\Component\Plugin\Context core/lib/Drupal/Component/Plugin/Context/ContextInterface.php Provides data and definitions for plugins during runtime and administration. 2 9
ContextPluginTest class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/ContextPluginTest.php Tests that contexts are properly set and working within plugins.
ContextProviderInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextProviderInterface.php Defines an interface for providing plugin contexts. 7 7
ContextProvidersPass class Drupal\Core\DependencyInjection\Compiler core/lib/Drupal/Core/DependencyInjection/Compiler/ContextProvidersPass.php Adds the context provider service IDs to the context manager. 1
ContextRepositoryInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextRepositoryInterface.php Offers a global context repository. 1 7
ContextTest class Drupal\Tests\Component\Plugin\Context core/tests/Drupal/Tests/Component/Plugin/Context/ContextTest.php @coversDefaultClass \Drupal\Component\Plugin\Context\Context @group Plugin
ContextTest class Drupal\Tests\Core\Plugin\Context core/tests/Drupal/Tests/Core/Plugin/Context/ContextTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\Context @group Plugin
ContextTypedDataTest class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/ContextTypedDataTest.php Tests that contexts work properly with the typed data manager.
ContextualController class Drupal\contextual core/modules/contextual/src/ContextualController.php Returns responses for Contextual module routes.
ContextualDynamicContextTest class Drupal\Tests\contextual\Functional core/modules/contextual/tests/src/Functional/ContextualDynamicContextTest.php Tests contextual link display on the front page based on permissions.
ContextualFiltersBlockContextTest class Drupal\Tests\views\Functional\Plugin core/modules/views/tests/src/Functional/Plugin/ContextualFiltersBlockContextTest.php A test for contextual filters exposed as block context.
ContextualFiltersStringTest class Drupal\Tests\views\Functional\Plugin core/modules/views/tests/src/Functional/Plugin/ContextualFiltersStringTest.php Test contextual filters with 'allow multiple values' setting for user roles.
ContextualFilterTest class Drupal\Tests\views\FunctionalJavascript\Plugin\views\Handler core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/ContextualFilterTest.php Tests the contextual filter handler UI.
ContextualLinkClickTrait trait Drupal\Tests\contextual\FunctionalJavascript core/modules/contextual/tests/src/FunctionalJavascript/ContextualLinkClickTrait.php Functions for testing contextual links. 14
ContextualLinkDefault class Drupal\Core\Menu core/lib/Drupal/Core/Menu/ContextualLinkDefault.php Provides a common base implementation of a contextual link. 2 4
ContextualLinkDefaultTest class Drupal\Tests\Core\Menu core/tests/Drupal/Tests/Core/Menu/ContextualLinkDefaultTest.php @group Menu @coversDefaultClass \Drupal\Core\Menu\ContextualLinkDefault
ContextualLinkInterface interface Drupal\Core\Menu core/lib/Drupal/Core/Menu/ContextualLinkInterface.php Defines a contextual link plugin. 1
ContextualLinkManager class Drupal\Core\Menu core/lib/Drupal/Core/Menu/ContextualLinkManager.php Defines a contextual link plugin manager to deal with contextual links. 1 2
ContextualLinkManagerInterface interface Drupal\Core\Menu core/lib/Drupal/Core/Menu/ContextualLinkManagerInterface.php Provides an object which returns the available contextual links. 1
ContextualLinkManagerTest class Drupal\Tests\Core\Menu core/tests/Drupal/Tests/Core/Menu/ContextualLinkManagerTest.php @coversDefaultClass \Drupal\Core\Menu\ContextualLinkManager @group Menu
ContextualLinks class Drupal\contextual\Element core/modules/contextual/src/Element/ContextualLinks.php Provides a contextual_links element.
ContextualLinks class Drupal\contextual\Plugin\views\field core/modules/contextual/src/Plugin/views/field/ContextualLinks.php Provides a handler that adds contextual links.
ContextualLinksPlaceholder class Drupal\contextual\Element core/modules/contextual/src/Element/ContextualLinksPlaceholder.php Provides a contextual_links_placeholder element.
ContextualLinksTest class Drupal\Tests\contextual\FunctionalJavascript core/modules/contextual/tests/src/FunctionalJavascript/ContextualLinksTest.php Tests the UI for correct contextual links.
ContextualLinksTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/ContextualLinksTest.php Test contextual links compatibility with the Layout Builder.
ContextualLinksTest class Drupal\Tests\node\FunctionalJavascript core/modules/node/tests/src/FunctionalJavascript/ContextualLinksTest.php Create a node with revisions and test contextual links.
ContextualUnitTest class Drupal\Tests\contextual\Kernel core/modules/contextual/tests/src/Kernel/ContextualUnitTest.php Tests edge cases for converting between contextual links and IDs.
ContextualValidatorInterface interface Drupal\Core\TypedData\Validation core/lib/Drupal/Core/TypedData/Validation/ContextualValidatorInterface.php Extends the contextual validator validate method by a new parameter. 1
Contrib class Drupal\ckeditor5\Plugin\CKEditor4To5Upgrade core/modules/ckeditor5/src/Plugin/CKEditor4To5Upgrade/Contrib.php Provides the CKEditor 4 to 5 upgrade path for contrib plugins now in core.
ControllerBase abstract class Drupal\Core\Controller core/lib/Drupal/Core/Controller/ControllerBase.php Utility base class for thin controllers. 90 90
ControllerBaseTest class Drupal\Tests\Core\Controller core/tests/Drupal/Tests/Core/Controller/ControllerBaseTest.php Tests that the base controller class.
ControllerResolver class Drupal\Core\Controller core/lib/Drupal/Core/Controller/ControllerResolver.php ControllerResolver to enhance controllers beyond Symfony's basic handling. 2 2

Other projects

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