Classes, traits, and interfaces - 10.3.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 1518

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
CKEditor5UpdateOlStartReversed		class	Drupal\Tests\ckeditor5\Functional\Update	core/modules/ckeditor5/tests/src/Functional/Update/CKEditor5UpdateOlStartReversed.php	@covers ckeditor5_post_update_list_start_reversed[[api-linebreak]] @group Update @group ckeditor5
CKEditor5UpdatePluginSettingsSortTest		class	Drupal\Tests\ckeditor5\Functional\Update	core/modules/ckeditor5/tests/src/Functional/Update/CKEditor5UpdatePluginSettingsSortTest.php	@covers ckeditor5_post_update_plugins_settings_export_order[[api-linebreak]] @group Update @group ckeditor5
CKEditor5ValidationTestTrait		trait	Drupal\Tests\ckeditor5\Kernel	core/modules/ckeditor5/tests/src/Kernel/CKEditor5ValidationTestTrait.php	Defines a trait for testing CKEditor 5 validity.
CKEditorStylesheetsWarningTest		class	Drupal\Tests\ckeditor5\FunctionalJavascript	core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditorStylesheetsWarningTest.php	Tests warnings when ckeditor_stylesheets do not have CKEditor 5 equivalents.
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.
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.		2
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	@coversDefaultClass \Drupal\Component\ClassFinder\ClassFinder[[api-linebreak]] @group ClassFinder
ClassLoaderTest		class	Drupal\Tests\system\Functional\Module	core/modules/system/tests/src/Functional/Module/ClassLoaderTest.php	Tests class loading for modules.
ClassRequiresAvailable		class	Drupal\BuildTests\Framework\Tests	core/tests/Drupal/BuildTests/Framework/Tests/ExternalCommandRequirementTest.php	@requires externalCommand available_command
ClassRequiresUnavailable		class	Drupal\BuildTests\Framework\Tests	core/tests/Drupal/BuildTests/Framework/Tests/ExternalCommandRequirementTest.php	@requires externalCommand unavailable_command
ClassResolver		class	Drupal\Core\DependencyInjection	core/lib/Drupal/Core/DependencyInjection/ClassResolver.php	Implements the class resolver interface supporting class names and services.		3	2
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	22
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");
ClassWriter		final class	Drupal\TestTools\PhpUnitCompatibility	core/tests/Drupal/TestTools/PhpUnitCompatibility/ClassWriter.php	Helper class to rewrite PHPUnit's TestCase class.		2
ClearCacheForm		class	Drupal\system\Form	core/modules/system/src/Form/ClearCacheForm.php	Clear caches for this site.		1
ClearTest		class	Drupal\Tests\system\Functional\Cache	core/modules/system/tests/src/Functional/Cache/ClearTest.php	Tests our clearing is done the proper way.
ClickSortingAJAXTest		class	Drupal\Tests\views\FunctionalJavascript	core/modules/views/tests/src/FunctionalJavascript/ClickSortingAJAXTest.php	Tests the click sorting AJAX functionality of Views exposed forms.
ClientErrorResponseSubscriber		class	Drupal\Core\EventSubscriber	core/lib/Drupal/Core/EventSubscriber/ClientErrorResponseSubscriber.php	Response subscriber to set the '4xx-response' cache tag on 4xx responses.			2
ClientFactory		class	Drupal\Core\Http	core/lib/Drupal/Core/Http/ClientFactory.php	Helper class to construct a HTTP client with Drupal specific config.		1	2
ClientFactoryTest		class	Drupal\Tests\Core\Http	core/tests/Drupal/Tests/Core/Http/ClientFactoryTest.php	@coversDefaultClass \Drupal\Core\Http\ClientFactory[[api-linebreak]] @group Http
CloseDialogCommand		class	Drupal\Core\Ajax	core/lib/Drupal/Core/Ajax/CloseDialogCommand.php	Defines an AJAX command that closes the current active dialog.	1	6
CloseModalDialogCommand		class	Drupal\Core\Ajax	core/lib/Drupal/Core/Ajax/CloseModalDialogCommand.php	Defines an AJAX command that closes the currently visible modal dialog.		5
CodeBlock		class	Drupal\ckeditor5\Plugin\CKEditor5Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/CodeBlock.php	CKEditor 5 Code Block plugin configuration.			1
CollapsedSummariesTest		class	Drupal\Tests\node\FunctionalJavascript	core/modules/node/tests/src/FunctionalJavascript/CollapsedSummariesTest.php	Tests that outlines of node meta values are displayed in summaries and tabs.
CollectRoutesTest		class	Drupal\Tests\rest\Unit	core/modules/rest/tests/src/Unit/CollectRoutesTest.php	Tests the REST export view plugin.
Color		class	Drupal\Core\Render\Element	core/lib/Drupal/Core/Render/Element/Color.php	Provides a form element for choosing a color.
Color		class	Drupal\Component\Utility	core/lib/Drupal/Component/Utility/Color.php	Performs color conversions.		6
ColorTest		class	Drupal\Tests\Component\Utility	core/tests/Drupal/Tests/Component/Utility/ColorTest.php	Tests Color utility class conversions.
Com		class	Drupal\Component\Uuid	core/lib/Drupal/Component/Uuid/Com.php	Generates a UUID using the Windows internal GUID extension.		1
Combine		class	Drupal\views\Plugin\views\filter	core/modules/views/src/Plugin/views/filter/Combine.php	Filter handler which allows to search on multiple fields.
CommandInterface		interface	Drupal\Core\Ajax	core/lib/Drupal/Core/Ajax/CommandInterface.php	AJAX command interface.	31	8
CommandLineOrUnsafeMethod		class	Drupal\Core\PageCache\RequestPolicy	core/lib/Drupal/Core/PageCache/RequestPolicy/CommandLineOrUnsafeMethod.php	Reject when running from the command line or when HTTP method is not safe.		2
CommandLineOrUnsafeMethodTest		class	Drupal\Tests\Core\PageCache	core/tests/Drupal/Tests/Core/PageCache/CommandLineOrUnsafeMethodTest.php	@coversDefaultClass \Drupal\Core\PageCache\RequestPolicy\CommandLineOrUnsafeMethod[[api-linebreak]] @group PageCache
CommandProvider		class	Drupal\Composer\Plugin\Scaffold	composer/Plugin/Scaffold/CommandProvider.php	List of all commands provided by this package.		1

Other projects

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