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
ContextDefinitionTest		class	Drupal\KernelTests\Core\Plugin\Annotation	core/tests/Drupal/KernelTests/Core/Plugin/Annotation/ContextDefinitionTest.php	Tests Drupal\Core\Annotation\ContextDefinition.
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	10
ContextHandlerTest		class	Drupal\KernelTests\Core\Plugin	core/tests/Drupal/KernelTests/Core/Plugin/ContextHandlerTest.php	Tests Drupal\Core\Plugin\Context\ContextHandler.
ContextHandlerTest		class	Drupal\Tests\Core\Plugin	core/tests/Drupal/Tests/Core/Plugin/ContextHandlerTest.php	Tests Drupal\Core\Plugin\Context\ContextHandler.
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	5
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	8
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
ContextRepositoryInterface		interface	Drupal\Core\Plugin\Context	core/lib/Drupal/Core/Plugin/Context/ContextRepositoryInterface.php	Offers a global context repository.	1	8
ContextTest		class	Drupal\Tests\Core\Plugin\Context	core/tests/Drupal/Tests/Core/Plugin/Context/ContextTest.php	Tests Drupal\Core\Plugin\Context\Context.
ContextTest		class	Drupal\Tests\Component\Plugin\Context	core/tests/Drupal/Tests/Component/Plugin/Context/ContextTest.php	Tests Drupal\Component\Plugin\Context\Context.
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.
ContextualHooks		class	Drupal\contextual\Hook	core/modules/contextual/src/Hook/ContextualHooks.php	Hook implementations for contextual.
ContextualLinkClickTrait		trait	Drupal\Tests\contextual\FunctionalJavascript	core/modules/contextual/tests/src/FunctionalJavascript/ContextualLinkClickTrait.php	Functions for testing contextual links.		12
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	Tests 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	Tests Drupal\Core\Menu\ContextualLinkManager.
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.
ContextualLinksHelper		class	Drupal\views	core/modules/views/src/ContextualLinksHelper.php	Views contextual links helper service.		6
ContextualLinksNegotiator		final class	Drupal\contextual\Theme	core/modules/contextual/src/Theme/ContextualLinksNegotiator.php	Set the theme according to the parameter passed to the controller.			2
ContextualLinksPlaceholder		class	Drupal\contextual\Element	core/modules/contextual/src/Element/ContextualLinksPlaceholder.php	Provides a contextual_links_placeholder element.		1
ContextualLinksSerializer		class	Drupal\contextual	core/modules/contextual/src/ContextualLinksSerializer.php	Helper methods to handle contextual links <-> ID conversion.		5
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.
ContextualTestHooks		class	Drupal\contextual_test\Hook	core/modules/contextual/tests/modules/contextual_test/src/Hook/ContextualTestHooks.php	Hook implementations for contextual_test.
ContextualThemeHooks		class	Drupal\contextual\Hook	core/modules/contextual/src/Hook/ContextualThemeHooks.php	Hook implementations for contextual.
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
ContextualViewsHooks		class	Drupal\contextual\Hook	core/modules/contextual/src/Hook/ContextualViewsHooks.php	Hook implementations for contextual.
ControllerBase		abstract class	Drupal\Core\Controller	core/lib/Drupal/Core/Controller/ControllerBase.php	Utility base class for thin controllers.	99	101
ControllerBaseTest		class	Drupal\Tests\Core\Controller	core/tests/Drupal/Tests/Core/Controller/ControllerBaseTest.php	Tests that the base controller class.
ControllerBaseTest		class	Drupal\KernelTests\Core\Controller	core/tests/Drupal/KernelTests/Core/Controller/ControllerBaseTest.php	Tests \Drupal\Core\Controller\ControllerBase.
ControllerResolver		class	Drupal\Core\Controller	core/lib/Drupal/Core/Controller/ControllerResolver.php	ControllerResolver to enhance controllers beyond Symfony's basic handling.		1	2
ControllerResolverInterface		interface	Drupal\Core\Controller	core/lib/Drupal/Core/Controller/ControllerResolverInterface.php	Extends the ControllerResolverInterface from symfony.	1	5
ControllerResolverTest		class	Drupal\Tests\Core\Controller	core/tests/Drupal/Tests/Core/Controller/ControllerResolverTest.php	Tests Drupal\Core\Controller\ControllerResolver.
ControllerSandboxManager		final class	Drupal\package_manager_test_api	core/modules/package_manager/tests/modules/package_manager_test_api/src/ApiController.php	Non-abstract version of StageBase.		1
Convert		class	Drupal\system\Plugin\ImageToolkit\Operation\gd	core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php	Defines GD2 convert operation.
ConvertImageEffect		class	Drupal\image\Plugin\ImageEffect	core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php	Converts an image resource.	1

Other projects

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