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
AccountSetEvent final class Drupal\Core\Session core/lib/Drupal/Core/Session/AccountSetEvent.php Event fired when an account is set for the current session.
AccountSettingsForm class Drupal\user core/modules/user/src/AccountSettingsForm.php Configure user settings for this site. 3 1
AccountSwitcher class Drupal\Core\Session core/lib/Drupal/Core/Session/AccountSwitcher.php An implementation of AccountSwitcherInterface. 2
AccountSwitcherInterface interface Drupal\Core\Session core/lib/Drupal/Core/Session/AccountSwitcherInterface.php Defines an interface for a service for safe account switching. 2 12
AccountSwitcherTest class Drupal\KernelTests\Core\Session core/tests/Drupal/KernelTests/Core/Session/AccountSwitcherTest.php Test case for account switching.
Action class Drupal\system\Entity core/modules/system/src/Entity/Action.php Defines the configured action entity. 23
Action class Drupal\system\Plugin\migrate\source core/modules/system/src/Plugin/migrate/source/Action.php Drupal action source from database. 1
Action class Drupal\Core\Action\Attribute core/lib/Drupal/Core/Action/Attribute/Action.php Defines an Action attribute object. 25
Action class Drupal\Core\Annotation core/lib/Drupal/Core/Annotation/Action.php Defines an Action annotation object.
ActionBase abstract class Drupal\Core\Action core/lib/Drupal/Core/Action/ActionBase.php Provides a base implementation for an Action plugin. 10 9
ActionConfigEntityInterface interface Drupal\system core/modules/system/src/ActionConfigEntityInterface.php Provides an interface defining an action entity. 1 2
ActionInterface interface Drupal\Core\Action core/lib/Drupal/Core/Action/ActionInterface.php Provides an interface for an Action plugin. 1 2 1
ActionJsonAnonTest class Drupal\Tests\system\Functional\Rest core/modules/system/tests/src/Functional/Rest/ActionJsonAnonTest.php @group Action
ActionJsonBasicAuthTest class Drupal\Tests\system\Functional\Rest core/modules/system/tests/src/Functional/Rest/ActionJsonBasicAuthTest.php @group Action
ActionJsonCookieTest class Drupal\Tests\system\Functional\Rest core/modules/system/tests/src/Functional/Rest/ActionJsonCookieTest.php @group Action
ActionManager class Drupal\Core\Action core/lib/Drupal/Core/Action/ActionManager.php Provides an Action plugin manager. 2 2
ActionMethod final class Drupal\Core\Config\Action\Attribute core/lib/Drupal/Core/Config/Action/Attribute/ActionMethod.php @internal This API is experimental. 10
ActionPluginCollection class Drupal\Core\Action core/lib/Drupal/Core/Action/ActionPluginCollection.php Provides a container for lazily loading Action plugins. 1
ActionResourceTestBase abstract class Drupal\Tests\system\Functional\Rest core/modules/system/tests/src/Functional/Rest/ActionResourceTestBase.php 6
Actions class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Actions.php Provides a wrapper element to group one or more buttons in a form.
ActionsTest class Drupal\KernelTests\Core\Render\Element core/tests/Drupal/KernelTests/Core/Render/Element/ActionsTest.php @coversDefaultClass \Drupal\Core\Render\Element\Actions[[api-linebreak]] @group Render
ActionTest class Drupal\Tests\system\Kernel\Action core/modules/system/tests/src/Kernel/Action/ActionTest.php Tests action plugins.
ActionTest class Drupal\Tests\system\Kernel\Plugin\migrate\source core/modules/system/tests/src/Kernel/Plugin/migrate/source/ActionTest.php Tests actions source plugin.
ActionTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/ActionTest.php JSON:API integration test for the "Action" config entity type.
ActionValidationTest class Drupal\Tests\system\Kernel\Entity core/modules/system/tests/src/Kernel/Entity/ActionValidationTest.php Tests validation of action entities.
ActionXmlAnonTest class Drupal\Tests\system\Functional\Rest core/modules/system/tests/src/Functional/Rest/ActionXmlAnonTest.php @group Action
ActionXmlBasicAuthTest class Drupal\Tests\system\Functional\Rest core/modules/system/tests/src/Functional/Rest/ActionXmlBasicAuthTest.php @group Action
ActionXmlCookieTest class Drupal\Tests\system\Functional\Rest core/modules/system/tests/src/Functional/Rest/ActionXmlCookieTest.php @group Action
ActiveLinkResponseFilter class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/ActiveLinkResponseFilter.php Subscribes to filter HTML responses, to set attributes on active links. 1 2
ActiveLinkResponseFilterTest class Drupal\Tests\Core\EventSubscriber core/tests/Drupal/Tests/Core/EventSubscriber/ActiveLinkResponseFilterTest.php @coversDefaultClass \Drupal\Core\EventSubscriber\ActiveLinkResponseFilter[[api-linebreak]] @group EventSubscriber
ActiveTheme class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ActiveTheme.php Defines a theme and its information needed at runtime. 6
ActiveWorkspaceCheck class Drupal\workspaces\Access core/modules/workspaces/src/Access/ActiveWorkspaceCheck.php Determines access to routes based on the presence of an active workspace. 1 2
ActiveWorkspaceCheckTest class Drupal\Tests\workspaces\Unit core/modules/workspaces/tests/src/Unit/ActiveWorkspaceCheckTest.php @coversDefaultClass \Drupal\workspaces\Access\ActiveWorkspaceCheck[[api-linebreak]]
ActiveWorkspaceUpdateTest class Drupal\Tests\workspaces\Functional\UpdateSystem core/modules/workspaces/tests/src/Functional/UpdateSystem/ActiveWorkspaceUpdateTest.php Tests that there is no active workspace during database updates.
AddBlockForm class Drupal\layout_builder\Form core/modules/layout_builder/src/Form/AddBlockForm.php Provides a form to add a block. 1
AddCssCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AddCssCommand.php An AJAX command for adding css to the page via ajax. 3
AddedStylesheetsTest class Drupal\Tests\ckeditor5\Functional core/modules/ckeditor5/tests/src/Functional/AddedStylesheetsTest.php Test the ckeditor5-stylesheets theme config property.
AddFeedTest class Drupal\Tests\system\Kernel\Common core/modules/system/tests/src/Kernel/Common/AddFeedTest.php Make sure that attaching feeds works correctly with various constructs.
AddFormBase abstract class Drupal\media_library\Form core/modules/media_library/src/Form/AddFormBase.php Provides a base class for creating media items from within the media library. 3 1
AddHandler class Drupal\views_ui\Form\Ajax core/modules/views_ui/src/Form/Ajax/AddHandler.php Provides a form for adding an item in the Views UI.
AddItemToToolbar final class Drupal\ckeditor5\Plugin\ConfigAction core/modules/ckeditor5/src/Plugin/ConfigAction/AddItemToToolbar.php
AddItemToToolbarConfigActionTest class Drupal\Tests\ckeditor5\Kernel\ConfigAction core/modules/ckeditor5/tests/src/Kernel/ConfigAction/AddItemToToolbarConfigActionTest.php @covers \Drupal\ckeditor5\Plugin\ConfigAction\AddItemToToolbar[[api-linebreak]] @group ckeditor5 @group Recipe
AddJsCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AddJsCommand.php An AJAX command for adding JS to the page via AJAX. 1
AddModeration final class Drupal\content_moderation\Plugin\ConfigAction core/modules/content_moderation/src/Plugin/ConfigAction/AddModeration.php
AddModerationConfigActionTest class Drupal\Tests\content_moderation\Kernel\ConfigAction core/modules/content_moderation/tests/src/Kernel/ConfigAction/AddModerationConfigActionTest.php @covers \Drupal\content_moderation\Plugin\ConfigAction\AddModeration[[api-linebreak]] @covers \Drupal\content_moderation\Plugin\ConfigAction\AddModerationDeriver[[api-linebreak]] @group content_moderation @group Recipe
AddModerationDeriver final class Drupal\content_moderation\Plugin\ConfigAction core/modules/content_moderation/src/Plugin/ConfigAction/AddModerationDeriver.php
AddRoleUser class Drupal\user\Plugin\Action core/modules/user/src/Plugin/Action/AddRoleUser.php Adds a role to a user. 1
AddRoleUserTest class Drupal\Tests\user\Unit\Plugin\Action core/modules/user/tests/src/Unit/Plugin/Action/AddRoleUserTest.php @coversDefaultClass \Drupal\user\Plugin\Action\AddRoleUser[[api-linebreak]] @group user
AddSectionController class Drupal\layout_builder\Controller core/modules/layout_builder/src/Controller/AddSectionController.php Defines a controller to add a new section.
AddToAllBundles final class Drupal\field\Plugin\ConfigAction core/modules/field/src/Plugin/ConfigAction/AddToAllBundles.php Adds a field to all bundles of its target entity type.

Other projects

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