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 1518

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
CategorizingPluginManagerInterface interface Drupal\Component\Plugin core/lib/Drupal/Component/Plugin/CategorizingPluginManagerInterface.php Defines an interface for plugin managers that categorize plugin definitions. 6 6
CategorizingPluginManagerTrait trait Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/CategorizingPluginManagerTrait.php Provides a trait for the CategorizingPluginManagerInterface. 5
CategorizingPluginManagerTraitTest class Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/CategorizingPluginManagerTraitTest.php @coversDefaultClass \Drupal\Core\Plugin\CategorizingPluginManagerTrait @group Plugin @runTestsInSeparateProcesses
CategoryAutocompleteController class Drupal\block\Controller core/modules/block/src/Controller/CategoryAutocompleteController.php Returns autocomplete responses for block categories. 1
CategoryAutocompleteTest class Drupal\Tests\block\Unit core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php @coversDefaultClass \Drupal\block\Controller\CategoryAutocompleteController @group block
ChainBreadcrumbBuilderInterface interface Drupal\Core\Breadcrumb core/lib/Drupal/Core/Breadcrumb/ChainBreadcrumbBuilderInterface.php Defines an interface a chained service that builds the breadcrumb. 1
ChainedFastBackend class Drupal\Core\Cache core/lib/Drupal/Core/Cache/ChainedFastBackend.php Defines a backend with a fast and a consistent backend chain. 3
ChainedFastBackendFactory class Drupal\Core\Cache core/lib/Drupal/Core/Cache/ChainedFastBackendFactory.php Defines the chained fast cache backend factory. 1
ChainedFastBackendFactoryTest class Drupal\Tests\Core\Cache core/tests/Drupal/Tests/Core/Cache/ChainedFastBackendFactoryTest.php @coversDefaultClass \Drupal\Core\Cache\ChainedFastBackendFactory @group Cache
ChainedFastBackendTest class Drupal\Tests\Core\Cache core/tests/Drupal/Tests/Core/Cache/ChainedFastBackendTest.php @coversDefaultClass \Drupal\Core\Cache\ChainedFastBackend @group Cache
ChainedFastBackendTest class Drupal\KernelTests\Core\Cache core/tests/Drupal/KernelTests/Core/Cache/ChainedFastBackendTest.php Unit test of the fast chained backend using the generic cache unit test base.
ChainedPlaceholderStrategy class Drupal\Core\Render\Placeholder core/lib/Drupal/Core/Render/Placeholder/ChainedPlaceholderStrategy.php Renders placeholders using a chain of placeholder strategies. 1
ChainedPlaceholderStrategyTest class Drupal\Tests\Core\Render\Placeholder core/tests/Drupal/Tests/Core/Render/Placeholder/ChainedPlaceholderStrategyTest.php @coversDefaultClass \Drupal\Core\Render\Placeholder\ChainedPlaceholderStrategy @group Render
ChainEntityResolver class Drupal\serialization\EntityResolver core/modules/serialization/src/EntityResolver/ChainEntityResolver.php Resolver delegating the entity resolution to a chain of resolvers. 1 2
ChainEntityResolverInterface interface Drupal\serialization\EntityResolver core/modules/serialization/src/EntityResolver/ChainEntityResolverInterface.php An interface for delegating an entity resolution to a chain of resolvers. 1
ChainEntityResolverTest class Drupal\Tests\serialization\Unit\EntityResolver core/modules/serialization/tests/src/Unit/EntityResolver/ChainEntityResolverTest.php @coversDefaultClass \Drupal\serialization\EntityResolver\ChainEntityResolver @group serialization
ChainRequestPolicy class Drupal\Core\PageCache core/lib/Drupal/Core/PageCache/ChainRequestPolicy.php Implements a compound request policy. 2 2
ChainRequestPolicyInterface interface Drupal\Core\PageCache core/lib/Drupal/Core/PageCache/ChainRequestPolicyInterface.php Defines the interface for compound request policies. 1
ChainRequestPolicyTest class Drupal\Tests\Core\PageCache core/tests/Drupal/Tests/Core/PageCache/ChainRequestPolicyTest.php @coversDefaultClass \Drupal\Core\PageCache\ChainRequestPolicy @group PageCache
ChainResponsePolicy class Drupal\Core\PageCache core/lib/Drupal/Core/PageCache/ChainResponsePolicy.php Implements a compound response policy. 1 2
ChainResponsePolicy class Drupal\Core\ProxyClass\PageCache core/lib/Drupal/Core/ProxyClass/PageCache/ChainResponsePolicy.php Provides a proxy class for \Drupal\Core\PageCache\ChainResponsePolicy.
ChainResponsePolicyInterface interface Drupal\Core\PageCache core/lib/Drupal/Core/PageCache/ChainResponsePolicyInterface.php Defines the interface for compound request policies. 2
ChainResponsePolicyTest class Drupal\Tests\Core\PageCache core/tests/Drupal/Tests/Core/PageCache/ChainResponsePolicyTest.php @coversDefaultClass \Drupal\Core\PageCache\ChainResponsePolicy @group PageCache
ChangedCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/ChangedCommand.php An AJAX command for marking HTML elements as changed. 2
ChangedFieldItemList class Drupal\Core\Field core/lib/Drupal/Core/Field/ChangedFieldItemList.php Defines an item list class for changed fields. 2
ChangedItem class Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/ChangedItem.php Defines the 'changed' entity field type. 1 2
ChangedTestItem class Drupal\entity_test\Plugin\Field\FieldType core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/ChangedTestItem.php Defines the 'changed_test' entity field type.
ChangeLogger final class Drupal\package_manager\EventSubscriber core/modules/package_manager/src/EventSubscriber/ChangeLogger.php Event subscriber to log changes that happen during the stage life cycle.
ChangeLoggerTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ChangeLoggerTest.php @covers \Drupal\package_manager\EventSubscriber\ChangeLogger @group package_manager
ChangeUserRoleBase abstract class Drupal\user\Plugin\Action core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php Provides a base class for operations to change a user's role. 2
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
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
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" )
ChildStage class Drupal\Tests\package_manager\Unit core/modules/package_manager/tests/src/Unit/StageBaseTest.php
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

Other projects

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