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 1519

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
CloseModalDialogCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/CloseModalDialogCommand.php Defines an AJAX command that closes the currently visible modal dialog. 2
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.
CollectPathsToExcludeEvent final class Drupal\package_manager\Event core/modules/package_manager/src/Event/CollectPathsToExcludeEvent.php Defines an event that collects paths to exclude. 18
CollectPathsToExcludeFailValidator class Drupal\package_manager_test_validation core/modules/package_manager/tests/modules/package_manager_test_validation/src/CollectPathsToExcludeFailValidator.php Allows to test an excluder which fails on CollectPathsToExcludeEvent. 2
CollectRelationshipMetaEvent final class Drupal\jsonapi\Events core/modules/jsonapi/src/Events/CollectRelationshipMetaEvent.php Event for collecting the relationship metadata of a JSON:API resource object. 3
CollectResourceObjectMetaEvent final class Drupal\jsonapi\Events core/modules/jsonapi/src/Events/CollectResourceObjectMetaEvent.php Event for collecting resource object metadata of a JSON:API resource types. 2
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 @group PageCache
CommandProvider class Drupal\Composer\Plugin\Scaffold composer/Plugin/Scaffold/CommandProvider.php List of all commands provided by this package. 1
CommandsTest class Drupal\KernelTests\Core\Ajax core/tests/Drupal/KernelTests/Core/Ajax/CommandsTest.php Performs tests on AJAX framework commands.
CommandsTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/CommandsTest.php Performs tests on AJAX framework commands.
CommandWithAttachedAssetsInterface interface Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/CommandWithAttachedAssetsInterface.php Interface for Ajax commands that render content and attach assets. 5
CommandWithAttachedAssetsTrait trait Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/CommandWithAttachedAssetsTrait.php Trait for Ajax commands that render content and attach assets.
Comment class Drupal\comment\Entity core/modules/comment/src/Entity/Comment.php Defines the comment entity class. 57
Comment class Drupal\comment\Plugin\views\wizard core/modules/comment/src/Plugin/views/wizard/Comment.php Tests creating comment views with the wizard.
Comment class Drupal\comment\Plugin\migrate\source\d6 core/modules/comment/src/Plugin/migrate/source/d6/Comment.php Drupal 6 comment source from database.
Comment class Drupal\comment\Plugin\migrate\source\d7 core/modules/comment/src/Plugin/migrate/source/d7/Comment.php Drupal 7 comment source from database.
CommentAccessControlHandler class Drupal\comment core/modules/comment/src/CommentAccessControlHandler.php Defines the access control handler for the comment entity type. 1
CommentAccessTest class Drupal\Tests\comment\Functional core/modules/comment/tests/src/Functional/CommentAccessTest.php Tests comment administration and preview access.
CommentActionsTest class Drupal\Tests\comment\Kernel core/modules/comment/tests/src/Kernel/CommentActionsTest.php Tests actions provided by the Comment module.
CommentAdminOverview class Drupal\comment\Form core/modules/comment/src/Form/CommentAdminOverview.php Provides the comments overview administration form. 1
CommentAdminTest class Drupal\Tests\comment\Functional core/modules/comment/tests/src/Functional/CommentAdminTest.php Tests comment approval functionality.
CommentAdminTest class Drupal\Tests\comment\Functional\Views core/modules/comment/tests/src/Functional/Views/CommentAdminTest.php Tests comment approval functionality.
CommentAdminViewTest class Drupal\Tests\comment\Kernel\Views core/modules/comment/tests/src/Kernel/Views/CommentAdminViewTest.php Tests comment admin view filters.
CommentAnonymousTest class Drupal\Tests\comment\Functional core/modules/comment/tests/src/Functional/CommentAnonymousTest.php Tests anonymous commenting.
CommentApproveLinkTest class Drupal\Tests\comment\Functional\Views core/modules/comment/tests/src/Functional/Views/CommentApproveLinkTest.php Test the "approve_comment" views field for approving comments.
CommentBaseFieldTest class Drupal\Tests\comment\Kernel core/modules/comment/tests/src/Kernel/CommentBaseFieldTest.php Tests that comment as a base field.
CommentBlockTest class Drupal\Tests\comment\Functional core/modules/comment/tests/src/Functional/CommentBlockTest.php Tests comment block functionality.
CommentBookTest class Drupal\Tests\book\Functional\Comment core/modules/book/tests/src/Functional/Comment/CommentBookTest.php Tests visibility of comments on book pages.
CommentBreadcrumbBuilder class Drupal\comment core/modules/comment/src/CommentBreadcrumbBuilder.php Class to define the comment breadcrumb builder. 2
CommentBulkForm class Drupal\comment\Plugin\views\field core/modules/comment/src/Plugin/views/field/CommentBulkForm.php Defines a comment operations bulk form element. 1
CommentBulkFormTest class Drupal\Tests\comment\Unit\Plugin\views\field core/modules/comment/tests/src/Unit/Plugin/views/field/CommentBulkFormTest.php @coversDefaultClass \Drupal\comment\Plugin\views\field\CommentBulkForm @group comment
CommentBundlesTest class Drupal\Tests\comment\Kernel core/modules/comment/tests/src/Kernel/CommentBundlesTest.php Tests that comment bundles behave as expected.
CommentCacheTagsTest class Drupal\Tests\comment\Functional core/modules/comment/tests/src/Functional/CommentCacheTagsTest.php Tests the Comment entity's cache tags.
CommentController class Drupal\comment\Controller core/modules/comment/src/Controller/CommentController.php Controller for the comment entity.
CommentCSSTest class Drupal\Tests\comment\Functional core/modules/comment/tests/src/Functional/CommentCSSTest.php Tests CSS classes on comments.
CommentDefaultFormatter class Drupal\comment\Plugin\Field\FieldFormatter core/modules/comment/src/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php Provides a default comment formatter.
CommentDefaultFormatterCacheTagsTest class Drupal\Tests\comment\Kernel core/modules/comment/tests/src/Kernel/CommentDefaultFormatterCacheTagsTest.php Tests comment cache tag bubbling up when using the Comment list formatter.
CommentDepthTest class Drupal\Tests\comment\Kernel\Views core/modules/comment/tests/src/Kernel/Views/CommentDepthTest.php Tests the depth of the comment field handler.
CommentDisplayConfigurableTest class Drupal\Tests\comment\Functional core/modules/comment/tests/src/Functional/CommentDisplayConfigurableTest.php Tests making comment base fields' displays configurable.
CommentDisplayConfigurableTestHooks class Drupal\comment_display_configurable_test\Hook core/modules/comment/tests/modules/comment_display_configurable_test/src/Hook/CommentDisplayConfigurableTestHooks.php Hook implementations for comment_display_configurable_test.
CommentedEntity class Drupal\comment\Plugin\views\field core/modules/comment/src/Plugin/views/field/CommentedEntity.php Views field display for commented entity.

Other projects

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