Classes, traits, and interfaces - 11.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 1531

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
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.	96	98
ControllerBaseTest		class	Drupal\KernelTests\Core\Controller	core/tests/Drupal/KernelTests/Core/Controller/ControllerBaseTest.php	Tests \Drupal\Core\Controller\ControllerBase.
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.		1	2
ControllerResolverInterface		interface	Drupal\Core\Controller	core/lib/Drupal/Core/Controller/ControllerResolverInterface.php	Extends the ControllerResolverInterface from symfony.	1	3
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
ConvertTest		class	Drupal\Tests\image\Functional\ImageEffect	core/modules/image/tests/src/Functional/ImageEffect/ConvertTest.php	Tests for the Convert image effect.
ConvertTokens		class	Drupal\user\Plugin\migrate\process	core/modules/user/src/Plugin/migrate/process/ConvertTokens.php	Plugin to replace !tokens with [tokens].		1
ConvertTokensTest		class	Drupal\Tests\user\Unit\Plugin\migrate\process	core/modules/user/tests/src/Unit/Plugin/migrate/process/ConvertTokensTest.php	Tests the ConvertTokens plugin.
Cookie		class	Drupal\user\Authentication\Provider	core/modules/user/src/Authentication/Provider/Cookie.php	Cookie based authentication provider.		1	2
CookieCacheContextTest		class	Drupal\Tests\Core\Cache\Context	core/tests/Drupal/Tests/Core/Cache/Context/CookieCacheContextTest.php	Tests Drupal\Core\Cache\Context\CookiesCacheContext.
CookieResourceTestTrait		trait	Drupal\Tests\rest\Functional	core/modules/rest/tests/src/Functional/CookieResourceTestTrait.php	Trait for ResourceTestBase subclasses testing $auth=cookie.		97
CookiesCacheContext		class	Drupal\Core\Cache\Context	core/lib/Drupal/Core/Cache/Context/CookiesCacheContext.php	Defines the CookiesCacheContext service, for "per cookie" caching.		1	2
CopyFieldValueTest		class	Drupal\Tests\system\FunctionalJavascript	core/modules/system/tests/src/FunctionalJavascript/CopyFieldValueTest.php	Tests copy field value functionality.
CopyFieldValueTestForm		class	Drupal\system_test\Form	core/modules/system/tests/modules/system_test/src/Form/CopyFieldValueTestForm.php	Provides a form to test Drupal.behaviors.copyFieldValue.			1
CopyTest		class	Drupal\Tests\file\Kernel	core/modules/file/tests/src/Kernel/CopyTest.php	Tests the file copy function.
CoreRecipesTest		class	Drupal\Tests\Core\Recipe	core/tests/Drupal/Tests/Core/Recipe/CoreRecipesTest.php	Tests that all core recipes have a generic test.
CoreServiceProvider		class	Drupal\Core	core/lib/Drupal/Core/CoreServiceProvider.php	ServiceProvider class for mandatory core services.
CoreThemesAutoloadedForTestsTest		class	Drupal\Tests\Core\Theme	core/tests/Drupal/Tests/Core/Theme/CoreThemesAutoloadedForTestsTest.php	Confirms that core/themes is autoloaded for tests.
Corn		class	Drupal\Tests\Component\Plugin\Fixtures\vegetable	core/tests/Drupal/Tests/Component/Plugin/Fixtures/vegetable/Corn.php	Plugin annotation @Plugin( id = "corn", label = "Corn", color = "yellow" )		1
CorsCompilerPass		class	Drupal\Core\DependencyInjection\Compiler	core/lib/Drupal/Core/DependencyInjection/Compiler/CorsCompilerPass.php	Provides a compiler pass which disables the CORS middleware in case disabled.		1
CorsIntegrationTest		class	Drupal\FunctionalTests\HttpKernel	core/tests/Drupal/FunctionalTests/HttpKernel/CorsIntegrationTest.php	Tests CORS provided by Drupal.
CountableResourceType		class	Drupal\jsonapi_test_collection_count\ResourceType	core/modules/jsonapi/tests/modules/jsonapi_test_collection_count/src/ResourceType/CountableResourceType.php	Subclass with overridden ::includeCount() for testing purposes.
CountableResourceTypeRepository		class	Drupal\jsonapi_test_collection_count\ResourceType	core/modules/jsonapi/tests/modules/jsonapi_test_collection_count/src/ResourceType/CountableResourceTypeRepository.php	Provides a repository of JSON:API configurable resource types.			2
CountConstraint		class	Drupal\Core\Validation\Plugin\Validation\Constraint	core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/CountConstraint.php	Count constraint.
Counter		class	Drupal\views\Plugin\views\field	core/modules/views/src/Plugin/views/field/Counter.php	Field handler to show a counter of the current row.		1
CounterTest		class	Drupal\Tests\views\Unit\Plugin\field	core/modules/views/tests/src/Unit/Plugin/field/CounterTest.php	Tests Drupal\views\Plugin\views\field\Counter.
CountryCodeConstraint		class	Drupal\Core\Validation\Plugin\Validation\Constraint	core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/CountryCodeConstraint.php	Validation constraint for country codes.		1
CountryCodeConstraintTest		class	Drupal\Tests\Core\Validation\Plugin\Validation\Constraint	core/tests/Drupal/Tests/Core/Validation/Plugin/Validation/Constraint/CountryCodeConstraintTest.php	Tests Country Code Constraint.
CountryManager		class	Drupal\Core\Locale	core/lib/Drupal/Core/Locale/CountryManager.php	Provides list of countries.		1	2
CountryManagerInterface		interface	Drupal\Core\Locale	core/lib/Drupal/Core/Locale/CountryManagerInterface.php	Defines a common interface for country managers.	1	3
CountryManagerTest		class	Drupal\KernelTests\Core\Locale	core/tests/Drupal/KernelTests/Core/Locale/CountryManagerTest.php	Tests Country Manager functionality.
CreatedItem		class	Drupal\Core\Field\Plugin\Field\FieldType	core/lib/Drupal/Core/Field/Plugin/Field/FieldType/CreatedItem.php	Defines the 'created' entity field type.	1	2
CreateForEachBundle		final class	Drupal\Core\Config\Action\Plugin\ConfigAction	core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/CreateForEachBundle.php	Creates config entities for each bundle of a particular entity type.		1
CreateForEachBundleDeriver		final class	Drupal\Core\Config\Action\Plugin\ConfigAction\Deriver	core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/Deriver/CreateForEachBundleDeriver.php	Generates derivatives for the create_for_each_bundle config action.		1
CreateMigrationsTrait		trait	Drupal\Tests\migrate_drupal\Traits	core/modules/migrate_drupal/tests/src/Traits/CreateMigrationsTrait.php	Test trait that provides instances of Drupal 6 and Drupal 7 migrations.		1
CreateNew		class	Drupal\system\Plugin\ImageToolkit\Operation\gd	core/modules/system/src/Plugin/ImageToolkit/Operation/gd/CreateNew.php	Defines GD2 create_new image operation.
CreateSampleEntityTest		class	Drupal\KernelTests\Core\Entity	core/tests/Drupal/KernelTests/Core/Entity/CreateSampleEntityTest.php	Tests the ContentEntityStorageBase::createWithSampleValues method.
CreateTestContentEntitiesTrait		trait	Drupal\Tests\migrate_drupal\Traits	core/modules/migrate_drupal/tests/src/Traits/CreateTestContentEntitiesTrait.php	Provides helper methods for creating test content.		5

Other projects

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