Classes, traits, and interfaces - main - 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 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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.
AdminVerticalTabsTest class Drupal\KernelTests\Core\Theme core/tests/Drupal/KernelTests/Core/Theme/AdminVerticalTabsTest.php Confirms that Admin can render vertical tabs correctly.
AdminViewsBulkOperationsTest class Drupal\FunctionalJavascriptTests\Theme core/tests/Drupal/FunctionalJavascriptTests/Theme/AdminViewsBulkOperationsTest.php Tests Admin's Views Bulk Operations form.
AdminViewsUiTest class Drupal\FunctionalJavascriptTests\Theme core/tests/Drupal/FunctionalJavascriptTests/Theme/AdminViewsUiTest.php Runs tests on Views UI using Admin.
AdvancedSettingsForm class Drupal\views_ui\Form core/modules/views_ui/src/Form/AdvancedSettingsForm.php Form builder for the advanced admin settings page.
AdvisoriesConfigSubscriber class Drupal\system\EventSubscriber core/modules/system/src/EventSubscriber/AdvisoriesConfigSubscriber.php Defines a config subscriber for changes to 'system.advisories'. 2
AdvisoryFeedTestHooks class Drupal\advisory_feed_test\Hook core/modules/system/tests/modules/advisory_feed_test/src/Hook/AdvisoryFeedTestHooks.php Hook implementations for advisory_feed_test.
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
AggregationTest class Drupal\Tests\views\Kernel core/modules/views/tests/src/Kernel/AggregationTest.php A basic aggregation test for Views.
AHooks class Drupal\aaa_hook_order_test\Hook core/modules/system/tests/modules/HookOrder/aaa_hook_order_test/src/Hook/AHooks.php Provides hook implementations for testing the execution order of hooks. 1
AjaxBasePageNegotiator class Drupal\Core\Theme core/lib/Drupal/Core/Theme/AjaxBasePageNegotiator.php Defines a theme negotiator that deals with the active theme on ajax requests. 1 2
AjaxBasePageNegotiatorTest class Drupal\Tests\Core\Theme core/tests/Drupal/Tests/Core/Theme/AjaxBasePageNegotiatorTest.php Tests Drupal\Core\Theme\AjaxBasePageNegotiator.
AjaxBlockTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/AjaxBlockTest.php Ajax blocks tests.
AjaxCallbacksTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxCallbacksTest.php Tests Ajax callbacks on FAPI elements.
AjaxCommandsTest class Drupal\Tests\Core\Ajax core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php Test coverage for various classes in the \Drupal\Core\Ajax namespace.
AjaxFileManagedMultipleTest class Drupal\Tests\file\FunctionalJavascript core/modules/file/tests/src/FunctionalJavascript/AjaxFileManagedMultipleTest.php Tests ajax upload to managed files.
AjaxFormBlock class Drupal\ajax_forms_test\Plugin\Block core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php Provides an AJAX form block.
AjaxFormCacheTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormCacheTest.php Tests the usage of form caching for AJAX forms.
AjaxFormHelperTrait trait Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AjaxFormHelperTrait.php Provides a helper to for submitting an AJAX form. 5
AjaxFormImageButtonTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormImageButtonTest.php Tests the Ajax image buttons work with key press events.
AjaxFormPageCacheTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormPageCacheTest.php Performs tests on AJAX forms in cached pages.
AjaxFormsTestAjaxElementsForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestAjaxElementsForm.php Builds a form where each Form API element triggers a simple Ajax callback. 1
AjaxFormsTestCommandsForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestCommandsForm.php Form constructor for the Ajax Command display form. 1
AjaxFormsTestImageButtonForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestImageButtonForm.php Form builder: Builds a form that has image button with an ajax callback. 1
AjaxFormsTestLazyLoadForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestLazyLoadForm.php Form builder: Builds a form that triggers a simple AJAX callback. 1
AjaxFormsTestSimpleForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestSimpleForm.php Form builder: Builds a form that triggers a simple AJAX callback. 1
AjaxFormsTestValidationForm class Drupal\ajax_forms_test\Form core/modules/system/tests/modules/ajax_forms_test/src/Form/AjaxFormsTestValidationForm.php Form builder: Builds a form that triggers a simple AJAX callback. 1
AjaxHelperTrait trait Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php Provides a helper to determine if the current request is via AJAX. 9
AjaxInGroupTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxInGroupTest.php Tests that form elements in groups work correctly with AJAX.
AjaxMaintenanceModeTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxMaintenanceModeTest.php Tests maintenance message during an AJAX call.
AjaxPageState class Drupal\Core\StackMiddleware core/lib/Drupal/Core/StackMiddleware/AjaxPageState.php Expands the compressed ajax_page_state query parameter into an array. 1 2
AjaxPageStateTest class Drupal\Tests\Core\StackMiddleware core/tests/Drupal/Tests/Core/StackMiddleware/AjaxPageStateTest.php Tests Drupal\Core\StackMiddleware\AjaxPageState.
AjaxPageStateTest class Drupal\Tests\system\Functional\Render core/modules/system/tests/src/Functional/Render/AjaxPageStateTest.php Performs tests for the effects of the ajax_page_state query parameter.
AjaxRenderer class Drupal\Core\Render\MainContent core/lib/Drupal/Core/Render/MainContent/AjaxRenderer.php Default main content renderer for Ajax requests. 1 2
AjaxRendererTest class Drupal\Tests\Core\Controller core/tests/Drupal/Tests/Core/Controller/AjaxRendererTest.php Tests Drupal\Core\Render\MainContent\AjaxRenderer.
AjaxResponse class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AjaxResponse.php JSON response object for AJAX requests. 2 47
AjaxResponseAttachmentsProcessor class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/AjaxResponseAttachmentsProcessor.php Processes attachments of AJAX responses. 2
AjaxResponseSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/AjaxResponseSubscriber.php Response subscriber to handle AJAX responses. 4 2
AjaxResponseTest class Drupal\Tests\Core\Ajax core/tests/Drupal/Tests/Core/Ajax/AjaxResponseTest.php Tests Drupal\Core\Ajax\AjaxResponse.
AjaxTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxTest.php Tests AJAX responses.
AjaxTest class Drupal\Tests\olivero\FunctionalJavascript core/themes/olivero/tests/src/FunctionalJavascript/AjaxTest.php Tests AJAX responses.
AjaxTestCommandReturnPromise class Drupal\ajax_test\Ajax core/modules/system/tests/modules/ajax_test/src/Ajax/AjaxTestCommandReturnPromise.php Test Ajax command. 1
AjaxTestController class Drupal\ajax_test\Controller core/modules/system/tests/modules/ajax_test/src/Controller/AjaxTestController.php Provides content for dialog tests. 3
AjaxTestDialogForm class Drupal\ajax_test\Form core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestDialogForm.php Dummy form for testing DialogRenderer with _form routes.
AjaxTestFocusFirstForm class Drupal\ajax_test\Form core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestFocusFirstForm.php Form for testing AJAX FocusFirstCommand. 1
AjaxTestForm class Drupal\ajax_test\Form core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestForm.php Dummy form for testing DialogRenderer with _form routes. 1
AjaxTestFormPromise class Drupal\ajax_test\Form core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestFormPromise.php Test form for ajax_test_form_promise. 1

Other projects

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