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 1529

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
CKEditor5PluginDefault		class	Drupal\ckeditor5\Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefault.php	Defines the default CKEditor 5 plugin implementation.	14	16
CKEditor5PluginDefinition		final class	Drupal\ckeditor5\Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefinition.php	Provides an implementation of a CKEditor 5 plugin definition.		19
CKEditor5PluginElementsSubsetInterface		interface	Drupal\ckeditor5\Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5PluginElementsSubsetInterface.php	Defines an interface for plugins that can support an elements subset.	7	8
CKEditor5PluginInterface		interface	Drupal\ckeditor5\Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5PluginInterface.php	Defines an interface for CKEditor 5 plugins.	2
CKEditor5PluginManager		class	Drupal\ckeditor5\Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5PluginManager.php	Provides a CKEditor 5 plugin manager.		3	2
CKEditor5PluginManagerInterface		interface	Drupal\ckeditor5\Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5PluginManagerInterface.php	Provides the interface for a plugin manager of CKEditor 5 plugins.	1	8
CKEditor5PluginManagerTest		class	Drupal\Tests\ckeditor5\Kernel	core/modules/ckeditor5/tests/src/Kernel/CKEditor5PluginManagerTest.php	Tests different ways of enabling CKEditor 5 plugins.
Ckeditor5ReadOnlyModeHooks		class	Drupal\ckeditor5_read_only_mode\Hook	core/modules/ckeditor5/tests/modules/ckeditor5_read_only_mode/src/Hook/Ckeditor5ReadOnlyModeHooks.php	Hook implementations for ckeditor5_read_only_mode.
CKEditor5ReadOnlyModeTest		class	Drupal\Tests\ckeditor5\FunctionalJavascript	core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5ReadOnlyModeTest.php	Tests read-only mode for CKEditor 5.
CKEditor5StylesheetsTest		class	Drupal\Tests\ckeditor5\Kernel	core/modules/ckeditor5/tests/src/Kernel/CKEditor5StylesheetsTest.php	Test the ckeditor5-stylesheets theme config property.
CKEditor5Test		class	Drupal\Tests\ckeditor5\Unit	core/modules/ckeditor5/tests/src/Unit/CKEditor5Test.php	Tests Drupal\ckeditor5\Plugin\Editor\CKEditor5.
CKEditor5Test		class	Drupal\Tests\ckeditor5\FunctionalJavascript	core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5Test.php	Tests for CKEditor 5.
CKEditor5TestBase		abstract class	Drupal\Tests\ckeditor5\FunctionalJavascript	core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5TestBase.php	Base class for testing CKEditor 5.	15
Ckeditor5TestHooks		class	Drupal\ckeditor5_test\Hook	core/modules/ckeditor5/tests/modules/ckeditor5_test/src/Hook/Ckeditor5TestHooks.php	Hook implementations for ckeditor5_test.
Ckeditor5TestModuleAllowedImageHooks		class	Drupal\ckeditor5_test_module_allowed_image\Hook	core/modules/ckeditor5/tests/modules/ckeditor5_test_module_allowed_image/src/Hook/Ckeditor5TestModuleAllowedImageHooks.php	Hook implementations for ckeditor5_test_module_allowed_image.
CKEditor5TestTrait		trait	Drupal\Tests\ckeditor5\Traits	core/modules/ckeditor5/tests/src/Traits/CKEditor5TestTrait.php	Provides methods to test CKEditor 5.		13
CKEditor5ToolbarTest		class	Drupal\Tests\ckeditor5\FunctionalJavascript	core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5ToolbarTest.php	Tests for CKEditor 5 editor UI with Toolbar module.
CKEditor5ValidationTestTrait		trait	Drupal\Tests\ckeditor5\Kernel	core/modules/ckeditor5/tests/src/Kernel/CKEditor5ValidationTestTrait.php	Defines a trait for testing CKEditor 5 validity.
CKEditor5ValidationTestTrait		trait	Drupal\Tests\ckeditor5\Traits	core/modules/ckeditor5/tests/src/Traits/CKEditor5ValidationTestTrait.php	Provides methods to test CKEditor 5 validation.		1
CkeditorTestHooks		class	Drupal\ckeditor_test\Hook	core/modules/ckeditor5/tests/modules/ckeditor_test/src/Hook/CkeditorTestHooks.php	Hook implementations for ckeditor_test.
ClaroBlockFilterTest		class	Drupal\FunctionalJavascriptTests\Theme	core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroBlockFilterTest.php	Runs BlockFilterTest in Claro.
ClaroEntityDisplayTest		class	Drupal\FunctionalJavascriptTests\Theme	core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroEntityDisplayTest.php	Runs EntityDisplayTest in Claro.
ClaroFormHooks		class	Drupal\claro\Hook	core/themes/claro/src/Hook/ClaroFormHooks.php	Form hooks for claro.
ClaroLayoutBuilderTest		class	Drupal\FunctionalTests\Theme	core/tests/Drupal/FunctionalTests/Theme/ClaroLayoutBuilderTest.php	Tests the layout builder with the Claro theme.
ClaroMenuUiJavascriptTest		class	Drupal\FunctionalJavascriptTests\Theme	core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroMenuUiJavascriptTest.php	Runs MenuUiJavascriptTest in Claro.
ClaroModalDisplayTest		class	Drupal\FunctionalJavascriptTests\Theme	core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroModalDisplayTest.php	Tests that buttons in modals are not in their button pane.
ClaroPasswordConfirmWidgetTest		class	Drupal\FunctionalJavascriptTests\Theme	core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroPasswordConfirmWidgetTest.php	Tests the password confirm widget with Claro theme.
ClaroPreRender		class	Drupal\claro	core/themes/claro/src/ClaroPreRender.php	Implements trusted prerender callbacks for the Claro theme.		2
ClaroTableDragTest		class	Drupal\FunctionalJavascriptTests\Theme	core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroTableDragTest.php	Tests draggable tables with Claro theme.
ClaroTest		class	Drupal\FunctionalTests\Theme	core/tests/Drupal/FunctionalTests/Theme/ClaroTest.php	Tests the Claro theme.
ClaroVerticalTabsTest		class	Drupal\KernelTests\Core\Theme	core/tests/Drupal/KernelTests/Core/Theme/ClaroVerticalTabsTest.php	Confirms that Claro can render vertical tabs correctly.
ClaroViewsBulkOperationsTest		class	Drupal\FunctionalJavascriptTests\Theme	core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroViewsBulkOperationsTest.php	Tests Claro's Views Bulk Operations form.
ClaroViewsUiTest		class	Drupal\FunctionalJavascriptTests\Theme	core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroViewsUiTest.php	Runs tests on Views UI using Claro.
ClassFinder		class	Drupal\Component\ClassFinder	core/lib/Drupal/Component/ClassFinder/ClassFinder.php	A Utility class that uses active autoloaders to find a file for a class.		3
ClassFinderInterface		interface	Drupal\Component\ClassFinder	core/lib/Drupal/Component/ClassFinder/ClassFinderInterface.php	Finds a class in a PSR-0 structure.	2	1
ClassFinderTest		class	Drupal\Tests\Component\ClassFinder	core/tests/Drupal/Tests/Component/ClassFinder/ClassFinderTest.php	Tests Drupal\Component\ClassFinder\ClassFinder.
ClassLoaderTest		class	Drupal\Tests\system\Functional\Module	core/modules/system/tests/src/Functional/Module/ClassLoaderTest.php	Tests class loading for modules.
ClassResolver		class	Drupal\Core\DependencyInjection	core/lib/Drupal/Core/DependencyInjection/ClassResolver.php	Implements the class resolver interface supporting class names and services.		4	2
ClassResolverConstraint		class	Drupal\Core\Validation\Plugin\Validation\Constraint	core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ClassResolverConstraint.php	Checks if a method on a service or instantiated object returns true.
ClassResolverConstraintValidator		class	Drupal\Core\Validation\Plugin\Validation\Constraint	core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ClassResolverConstraintValidator.php	Validates if a method on a service or instantiated object returns true.		1
ClassResolverConstraintValidatorTest		class	Drupal\KernelTests\Core\TypedData	core/tests/Drupal/KernelTests/Core/TypedData/ClassResolverConstraintValidatorTest.php	Tests ClassResolver validation constraint with both valid and invalid values.
ClassResolverInterface		interface	Drupal\Core\DependencyInjection	core/lib/Drupal/Core/DependencyInjection/ClassResolverInterface.php	Provides interface to get an instance of a class with dependency injection.	1	23
ClassWithConstants		class	Drupal\Tests\Component\Annotation\Doctrine\Fixtures	core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/ClassWithConstants.php			1
ClassWithInvalidAnnotationTargetAtClass		class	Drupal\Tests\Component\Annotation\Doctrine\Fixtures	core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/ClassWithInvalidAnnotationTargetAtClass.php	Plugin annotation @AnnotationTargetPropertyMethod("Some data");
ClassWithInvalidAnnotationTargetAtMethod		class	Drupal\Tests\Component\Annotation\Doctrine\Fixtures	core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/ClassWithInvalidAnnotationTargetAtMethod.php	Plugin annotation @AnnotationTargetClass("Some data");
ClassWithInvalidAnnotationTargetAtProperty		class	Drupal\Tests\Component\Annotation\Doctrine\Fixtures	core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/ClassWithInvalidAnnotationTargetAtProperty.php	Plugin annotation @AnnotationTargetClass("Some data");
ClassWithValidAnnotationTarget		class	Drupal\Tests\Component\Annotation\Doctrine\Fixtures	core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/ClassWithValidAnnotationTarget.php	Plugin annotation @AnnotationTargetClass("Some data");
Cleaner		final class	Drupal\package_manager\Plugin\QueueWorker	core/modules/package_manager/src/Plugin/QueueWorker/Cleaner.php	Processes a queue of defunct stage directories, deleting them.
ClearCacheBlock		class	Drupal\system\Plugin\Block	core/modules/system/src/Plugin/Block/ClearCacheBlock.php	Provides a block to display 'Clear cache' elements.
ClearCacheBlockTest		class	Drupal\Tests\system\Functional\Block	core/modules/system/tests/src/Functional/Block/ClearCacheBlockTest.php	Tests clear cache block behavior.

Other projects

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