Classes, traits, and interfaces - 10.3.x - drupal

Primary tabs

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
Checkbox class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Checkbox.php Provides a form element for a single checkbox.
Checkboxes class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Checkboxes.php Provides a form element for a set of checkboxes. 3
CheckboxTest class Drupal\Tests\system\Functional\Form core/modules/system/tests/src/Functional/Form/CheckboxTest.php Tests the form API checkbox element.
Checkpoint final class Drupal\Core\Config\Checkpoint core/lib/Drupal/Core/Config/Checkpoint/Checkpoint.php A value object to store information about a checkpoint. 5
CheckpointExistsException final class Drupal\Core\Config\Checkpoint core/lib/Drupal/Core/Config/Checkpoint/CheckpointExistsException.php Thrown when trying to add a checkpoint with an ID that already exists. 1
CheckpointListInterface interface Drupal\Core\Config\Checkpoint core/lib/Drupal/Core/Config/Checkpoint/CheckpointListInterface.php Maintains a list of checkpoints. 1
CheckpointStorage final class Drupal\Core\Config\Checkpoint core/lib/Drupal/Core/Config/Checkpoint/CheckpointStorage.php Provides a config storage that can make checkpoints. 1 2
CheckpointStorageInterface interface Drupal\Core\Config\Checkpoint core/lib/Drupal/Core/Config/Checkpoint/CheckpointStorageInterface.php Provides an interface for checkpoint storages. 1 1
CheckpointStorageTest class Drupal\KernelTests\Core\Config\Storage\Checkpoint core/tests/Drupal/KernelTests/Core/Config/Storage/Checkpoint/CheckpointStorageTest.php Tests CheckpointStorage operations.
CheckpointStorageTest class Drupal\Tests\Core\Config\Checkpoint core/tests/Drupal/Tests/Core/Config/Checkpoint/CheckpointStorageTest.php @coversDefaultClass \Drupal\Core\Config\Checkpoint\CheckpointStorage @group Config
CheckProvider class Drupal\Core\Access core/lib/Drupal/Core/Access/CheckProvider.php Loads access checkers from the container. 1 2
CheckProviderInterface interface Drupal\Core\Access core/lib/Drupal/Core/Access/CheckProviderInterface.php Provides the available access checkers by service IDs. 1 1
CheckRequirementsTest class Drupal\Tests\migrate\Unit\Plugin\migrate\destination core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/CheckRequirementsTest.php Tests check requirements exception on DestinationBase.
Cherry class Drupal\plugin_test\Plugin\plugin_test\fruit core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/Cherry.php Plugin annotation @Plugin( id = "cherry", label = "Cherry", color = "red" )
ChmodInterface interface Drupal\Core\FileTransfer core/lib/Drupal/Core/FileTransfer/ChmodInterface.php Defines an interface to chmod files. 3
ChooseBlockController class Drupal\layout_builder\Controller core/modules/layout_builder/src/Controller/ChooseBlockController.php Defines a controller to choose a new block.
ChooseSectionController class Drupal\layout_builder\Controller core/modules/layout_builder/src/Controller/ChooseSectionController.php Defines a controller to choose a new section.
CKEditor4To5Upgrade class Drupal\ckeditor5\Annotation core/modules/ckeditor5/src/Annotation/CKEditor4To5Upgrade.php Defines a CKEditor4To5Upgrade annotation object. 1
CKEditor4To5UpgradePluginInterface interface Drupal\ckeditor5\Plugin core/modules/ckeditor5/src/Plugin/CKEditor4To5UpgradePluginInterface.php Defines an interface for CKEditor 4 to 5 upgrade plugins. 2 2
CKEditor4To5UpgradePluginManager class Drupal\ckeditor5\Plugin core/modules/ckeditor5/src/Plugin/CKEditor4To5UpgradePluginManager.php Provides a CKEditor 4 to 5 upgrade plugin manager. 2
CKEditor5 class Drupal\ckeditor5\Plugin\Editor core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php Defines a CKEditor 5-based text editor for Drupal. 25
CKEditor5AllowedTagsTest class Drupal\Tests\ckeditor5\FunctionalJavascript core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php Tests for CKEditor 5.
CKEditor5AspectsOfCKEditor5Plugin class Drupal\ckeditor5\Annotation core/modules/ckeditor5/src/Annotation/CKEditor5AspectsOfCKEditor5Plugin.php Defines the "CKEditor 5 aspects of a CKEditor5Plugin" annotation object. 1
CKEditor5AspectsOfCKEditor5Plugin class Drupal\ckeditor5\Attribute core/modules/ckeditor5/src/Attribute/CKEditor5AspectsOfCKEditor5Plugin.php
CKEditor5CacheTag class Drupal\ckeditor5\EventSubscriber core/modules/ckeditor5/src/EventSubscriber/CKEditor5CacheTag.php A subscriber invalidating cache tags when the default theme changes. 2
CKEditor5DialogTest class Drupal\Tests\ckeditor5\FunctionalJavascript core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5DialogTest.php Tests for CKEditor 5 to ensure correct focus management in dialogs.
CKEditor5DialogTestController class Drupal\ckeditor5_test\Controller core/modules/ckeditor5/tests/modules/ckeditor5_test/src/Controller/CKEditor5DialogTestController.php Provides controller for testing CKEditor in off-canvas dialogs.
CKEditor5ElementConstraint class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/CKEditor5ElementConstraint.php CKEditor 5 element.
CKEditor5ElementConstraintValidator class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/CKEditor5ElementConstraintValidator.php CKEditor 5 element validator.
CKEditor5FragmentLinkTest class Drupal\Tests\ckeditor5\FunctionalJavascript core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5FragmentLinkTest.php Tests that the fragment link points to CKEditor 5.
CKEditor5ImageController class Drupal\ckeditor5\Controller core/modules/ckeditor5/src/Controller/CKEditor5ImageController.php Returns response for CKEditor 5 Simple image upload adapter.
CKEditor5MarkupTest class Drupal\Tests\ckeditor5\FunctionalJavascript core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5MarkupTest.php Tests for CKEditor 5.
CKEditor5MediaAndFilterSettingsInSyncConstraint class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/CKEditor5MediaAndFilterSettingsInSyncConstraint.php Ensure CKEditor 5 media plugin's and media filter's settings are in sync.
CKEditor5MediaAndFilterSettingsInSyncConstraintValidator class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/CKEditor5MediaAndFilterSettingsInSyncConstraintValidator.php CKEditor 5 Media plugin in sync with the filter settings validator.
CKEditor5MediaController class Drupal\ckeditor5\Controller core/modules/ckeditor5/src/Controller/CKEditor5MediaController.php Provides an API for checking if a media entity has image field.
CKEditor5OffCanvasTest class Drupal\Tests\ckeditor5\FunctionalJavascript core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5OffCanvasTest.php Tests for CKEditor 5 to ensure correct styling in off-canvas.
CKEditor5OffCanvasTestController class Drupal\ckeditor5_test\Controller core/modules/ckeditor5/tests/modules/ckeditor5_test/src/Controller/CKEditor5OffCanvasTestController.php Provides controller for testing CKEditor in off-canvas dialogs.
CKEditor5Plugin class Drupal\ckeditor5\Annotation core/modules/ckeditor5/src/Annotation/CKEditor5Plugin.php Defines a CKEditor5Plugin annotation object. 1
CKEditor5Plugin class Drupal\ckeditor5\Attribute core/modules/ckeditor5/src/Attribute/CKEditor5Plugin.php The CKEditor5Plugin attribute. 1
CKEditor5PluginConfigurableInterface interface Drupal\ckeditor5\Plugin core/modules/ckeditor5/src/Plugin/CKEditor5PluginConfigurableInterface.php Defines an interface for configurable CKEditor 5 plugins. 11 11
CKEditor5PluginConfigurableTrait trait Drupal\ckeditor5\Plugin core/modules/ckeditor5/src/Plugin/CKEditor5PluginConfigurableTrait.php Provides a trait for configurable CKEditor 5 plugins. 11
CKEditor5PluginDefault class Drupal\ckeditor5\Plugin core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefault.php Defines the default CKEditor 5 plugin implementation. 13 15
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 9
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. 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 6
CKEditor5PluginManagerTest class Drupal\Tests\ckeditor5\Kernel core/modules/ckeditor5/tests/src/Kernel/CKEditor5PluginManagerTest.php Tests different ways of enabling CKEditor 5 plugins.
CKEditor5ReadOnlyModeTest class Drupal\Tests\ckeditor5\FunctionalJavascript core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5ReadOnlyModeTest.php Tests read-only mode for CKEditor 5.
CKEditor5StylesheetsMessage final class Drupal\ckeditor5 core/modules/ckeditor5/src/CKEditor5StylesheetsMessage.php Messaging for themes using the ckeditor_stylesheets setting. 1 2

Other projects


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