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
ActionXmlBasicAuthTest class Drupal\Tests\action\Functional\Rest core/modules/action/tests/src/Functional/Rest/ActionXmlBasicAuthTest.php @group action
ActionXmlCookieTest class Drupal\Tests\action\Functional\Rest core/modules/action/tests/src/Functional/Rest/ActionXmlCookieTest.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
ActiveLinkResponseFilterTest class Drupal\Tests\Core\EventSubscriber core/tests/Drupal/Tests/Core/EventSubscriber/ActiveLinkResponseFilterTest.php @coversDefaultClass \Drupal\Core\EventSubscriber\ActiveLinkResponseFilter @group EventSubscriber @group #slow
ActiveTheme class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ActiveTheme.php Defines a theme and its information needed at runtime. 6
ActiveTopicsBlock class Drupal\forum\Plugin\Block core/modules/forum/src/Plugin/Block/ActiveTopicsBlock.php Provides an 'Active forum topics' block.
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
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 @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 @covers \Drupal\content_moderation\Plugin\ConfigAction\AddModerationDeriver @group content_moderation @group Recipe
AddModerationDeriver final class Drupal\content_moderation\Plugin\ConfigAction core/modules/content_moderation/src/Plugin/ConfigAction/AddModerationDeriver.php
AddPermissionsUpdateTest class Drupal\Tests\help\Functional core/modules/help/tests/src/Functional/AddPermissionsUpdateTest.php Tests help_post_update_add_permissions_to_roles().
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 @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.
AddToAllBundlesConfigActionTest class Drupal\Tests\field\Kernel core/modules/field/tests/src/Kernel/AddToAllBundlesConfigActionTest.php @covers \Drupal\field\Plugin\ConfigAction\AddToAllBundles
AdminAccountSwitcher final class Drupal\Core\DefaultContent core/lib/Drupal/Core/DefaultContent/AdminAccountSwitcher.php @internal This API is experimental. 1
AdminAccountSwitcherTest class Drupal\KernelTests\Core\DefaultContent core/tests/Drupal/KernelTests/Core/DefaultContent/AdminAccountSwitcherTest.php @covers \Drupal\Core\DefaultContent\AdminAccountSwitcher @group DefaultContent
AdminAjaxTest class Drupal\Tests\views_ui\FunctionalJavascript core/modules/views_ui/tests/src/FunctionalJavascript/AdminAjaxTest.php Tests the admin UI AJAX interactions.
AdminContext class Drupal\Core\Routing core/lib/Drupal/Core/Routing/AdminContext.php Provides a helper class to determine whether the route is an admin one. 5
AdminController class Drupal\system\Controller core/modules/system/src/Controller/AdminController.php Controller for admin section.
AdminDemoNegotiator class Drupal\block\Theme core/modules/block/src/Theme/AdminDemoNegotiator.php Negotiates the theme for the block admin demo page via the URL. 2
AdminHtmlRouteProvider class Drupal\Core\Entity\Routing core/lib/Drupal/Core/Entity/Routing/AdminHtmlRouteProvider.php Provides HTML routes for entities with administrative add/edit/delete pages. 2 3
AdminMetaTagTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/AdminMetaTagTest.php Confirm that the fingerprinting meta tag appears as expected.
AdminNegotiator class Drupal\user\Theme core/modules/user/src/Theme/AdminNegotiator.php Sets the active theme on admin pages. 1 2
AdminNegotiatorTest class Drupal\Tests\user\Unit\Theme core/modules/user/tests/src/Unit/Theme/AdminNegotiatorTest.php Tests AdminNegotiator class.
AdminPathConfigEntityConverter class Drupal\Core\ProxyClass\ParamConverter core/lib/Drupal/Core/ProxyClass/ParamConverter/AdminPathConfigEntityConverter.php Provides a proxy class for \Drupal\Core\ParamConverter\AdminPathConfigEntityConverter.
AdminPathConfigEntityConverter class Drupal\Core\ParamConverter core/lib/Drupal/Core/ParamConverter/AdminPathConfigEntityConverter.php Makes sure the unmodified ConfigEntity is loaded on admin pages. 1 1
AdminPathEntityConverterLanguageTest class Drupal\Tests\language\Functional core/modules/language/tests/src/Functional/AdminPathEntityConverterLanguageTest.php Test administration path based conversion of entities. 1 1
AdminRouteSubscriber class Drupal\system\EventSubscriber core/modules/system/src/EventSubscriber/AdminRouteSubscriber.php Adds the _admin_route option to each admin HTML route. 1 2
AdminRouteSubscriberTest class Drupal\Tests\system\Unit\Routing core/modules/system/tests/src/Unit/Routing/AdminRouteSubscriberTest.php @coversDefaultClass \Drupal\system\EventSubscriber\AdminRouteSubscriber @group system
AdminTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/AdminTest.php Tests output on administrative pages and compact mode functionality.
AdminUiTest class Drupal\Tests\ckeditor5\FunctionalJavascript core/modules/ckeditor5/tests/src/FunctionalJavascript/AdminUiTest.php Tests for CKEditor 5 in the admin UI.
AdvancedSettingsForm class Drupal\views_ui\Form core/modules/views_ui/src/Form/AdvancedSettingsForm.php Form builder for the advanced admin settings page. 1
AdvisoriesConfigSubscriber class Drupal\system\EventSubscriber core/modules/system/src/EventSubscriber/AdvisoriesConfigSubscriber.php Defines a config subscriber for changes to 'system.advisories'. 2
AdvisoryTestClientMiddleware class Drupal\advisory_feed_test core/modules/system/tests/modules/advisory_feed_test/src/AdvisoryTestClientMiddleware.php Overrides the User-Agent HTTP header for outbound HTTP requests. 1 2
AdvisoryTestController class Drupal\advisory_feed_test\Controller core/modules/system/tests/modules/advisory_feed_test/src/Controller/AdvisoryTestController.php Defines a controller to return JSON for security advisory tests.
AfterCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AfterCommand.php An AJAX command for calling the jQuery after() method. 2

Other projects

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