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
OEmbedIframeController class Drupal\media\Controller core/modules/media/src/Controller/OEmbedIframeController.php Controller which renders an oEmbed resource in a bare page (without blocks). 1
OEmbedIframeControllerTest class Drupal\Tests\media\Kernel core/modules/media/tests/src/Kernel/OEmbedIframeControllerTest.php Tests Drupal\media\Controller\OEmbedIframeController.
OEmbedInterface interface Drupal\media\Plugin\media\Source core/modules/media/src/Plugin/media/Source/OEmbedInterface.php Defines additional functionality for source plugins that use oEmbed. 1 5
OEmbedMediaSource class Drupal\media\Attribute core/modules/media/src/Attribute/OEmbedMediaSource.php Defines a OEmbedMediaSource attribute. 1
OEmbedResourceConstraint class Drupal\media\Plugin\Validation\Constraint core/modules/media/src/Plugin/Validation/Constraint/OEmbedResourceConstraint.php Checks if a value represents a valid oEmbed resource URL. 1
OEmbedResourceConstraintValidator class Drupal\media\Plugin\Validation\Constraint core/modules/media/src/Plugin/Validation/Constraint/OEmbedResourceConstraintValidator.php Validates oEmbed resource URLs. 1
OEmbedResourceConstraintValidatorTest class Drupal\Tests\media\Kernel core/modules/media/tests/src/Kernel/OEmbedResourceConstraintValidatorTest.php Tests Drupal\media\Plugin\Validation\Constraint\OEmbedResourceConstraintValidator.
OEmbedSourceTest class Drupal\Tests\media\Kernel core/modules/media/tests/src/Kernel/OEmbedSourceTest.php Tests Drupal\media\Plugin\media\Source\OEmbed.
OEmbedTestTrait trait Drupal\Tests\media\Traits core/modules/media/tests/src/Traits/OEmbedTestTrait.php Contains helper functions for testing oEmbed functionality in isolation. 6
OEmbedWidget class Drupal\media\Plugin\Field\FieldWidget core/modules/media/src/Plugin/Field/FieldWidget/OEmbedWidget.php Plugin implementation of the 'oembed_textfield' widget. 1
OffCanvasDialogTest class Drupal\Tests\system\Functional\Ajax core/modules/system/tests/src/Functional/Ajax/OffCanvasDialogTest.php Performs tests on opening and manipulating dialogs via AJAX commands.
OffCanvasRenderer class Drupal\Core\Render\MainContent core/lib/Drupal/Core/Render/MainContent/OffCanvasRenderer.php Default main content renderer for off-canvas dialog requests. 3
OffCanvasTest class Drupal\Tests\system\FunctionalJavascript core/modules/system/tests/src/FunctionalJavascript/OffCanvasTest.php Tests the off-canvas dialog functionality.
OffCanvasTestBase abstract class Drupal\Tests\system\FunctionalJavascript core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php Base class contains common test functionality for the Off-canvas dialog. 7 6
OffCanvasTestHooks class Drupal\off_canvas_test\Hook core/modules/system/tests/modules/off_canvas_test/src/Hook/OffCanvasTestHooks.php Hook implementations for off_canvas_test.
OffCanvasTestTrait trait Drupal\Tests\system\Traits core/modules/system/tests/src/Traits/OffCanvasTestTrait.php Provides helper methods for interacting with the off-canvas area. 8
OffsetPage class Drupal\jsonapi\Query core/modules/jsonapi/src/Query/OffsetPage.php Value object for containing the requested offset and page parameters. 3
OffsetPageTest class Drupal\Tests\jsonapi\Unit\Query core/modules/jsonapi/tests/src/Unit/Query/OffsetPageTest.php Tests Drupal\jsonapi\Query\OffsetPage.
OliveroAvoidStorageUsingTest final class Drupal\FunctionalJavascriptTests\Theme core/tests/Drupal/FunctionalJavascriptTests/Theme/OliveroAvoidStorageUsingTest.php Tests usage of localStorage.
OliveroHexToHslTest final class Drupal\Tests\olivero\Unit core/themes/olivero/tests/src/Unit/OliveroHexToHslTest.php Tests the \Drupal\olivero\HexToHslTrait:convertHexToHsl() function.
OliveroHooks class Drupal\olivero\Hook core/themes/olivero/src/Hook/OliveroHooks.php Hook implementations for olivero.
OliveroMessagesTest class Drupal\FunctionalJavascriptTests\Theme core/tests/Drupal/FunctionalJavascriptTests/Theme/OliveroMessagesTest.php Runs OliveroMessagesTest in Olivero.
OliveroPagePreprocessHooks class Drupal\olivero\Hook core/themes/olivero/src/Hook/OliveroPagePreprocessHooks.php Page preprocess hooks for olivero.
OliveroPostUpdateTest class Drupal\Tests\olivero\Functional\Update core/themes/olivero/tests/src/Functional/Update/OliveroPostUpdateTest.php Tests the update path for Olivero.
OliveroPreRender class Drupal\olivero core/themes/olivero/src/OliveroPreRender.php Implements trusted prerender callbacks for the Olivero theme. 1
OliveroTest class Drupal\FunctionalTests\Theme core/tests/Drupal/FunctionalTests/Theme/OliveroTest.php Tests the Olivero theme.
OliveroTestThemeHooks class Drupal\olivero_test\Hook core/modules/system/tests/modules/olivero_test/src/Hook/OliveroTestThemeHooks.php Hook implementations for olivero_test.
OmittedData class Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/OmittedData.php Represents resource data that should be omitted from the JSON:API document. 1
OnBehalfOfOtherModuleHook class Drupal\hook_collector_on_behalf\Hook core/modules/system/tests/modules/hook_collector_on_behalf/src/Hook/OnBehalfOfOtherModuleHook.php Hook implementation on behalf of another module.
OneTimeAuthentication final class Drupal\user core/modules/user/src/OneTimeAuthentication.php Generate and verify one time authentication codes. 14
OneTimeAuthenticationTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/OneTimeAuthenticationTest.php Tests OneTimeAuthentication service.
OpCodeCache class Drupal\Component\Utility core/lib/Drupal/Component/Utility/OpCodeCache.php Provides helpers to handle PHP opcode caches. 6
OpenDialogCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/OpenDialogCommand.php Defines an AJAX command to open certain content in a dialog. 2 3
OpenerResolver class Drupal\media_library core/modules/media_library/src/OpenerResolver.php Defines a class to resolve media library openers. 2
OpenerResolverInterface interface Drupal\media_library core/modules/media_library/src/OpenerResolverInterface.php Defines an interface to get a media library opener from the container. 1 3
OpenModalDialogCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/OpenModalDialogCommand.php An AJAX command to open certain content in a dialog in a modal dialog. 5
OpenModalDialogWithUrl class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/OpenModalDialogWithUrl.php Provides an AJAX command for opening a modal with URL. 3
OpenOffCanvasDialogCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/OpenOffCanvasDialogCommand.php Defines an AJAX command to open content in a dialog in an off-canvas tray. 2
OpenOffCanvasDialogCommandTest class Drupal\Tests\Core\Ajax core/tests/Drupal/Tests/Core/Ajax/OpenOffCanvasDialogCommandTest.php Tests Drupal\Core\Ajax\OpenOffCanvasDialogCommand.
OpenTelemetryAuthenticatedPerformanceTest class Drupal\Tests\demo_umami\FunctionalJavascript core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryAuthenticatedPerformanceTest.php Tests demo_umami profile performance.
OpenTelemetryFrontPagePerformanceTest class Drupal\Tests\demo_umami\FunctionalJavascript core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryFrontPagePerformanceTest.php Tests demo_umami profile performance.
OpenTelemetryNodePagePerformanceTest class Drupal\Tests\demo_umami\FunctionalJavascript core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryNodePagePerformanceTest.php Tests demo_umami profile performance.
OpenTelemetryPerformanceTest class Drupal\Tests\demo_umami\FunctionalJavascript core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryPerformanceTest.php Tests demo_umami profile performance.
OperationBase abstract class Drupal\image_test\Plugin\ImageToolkit\Operation\test core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/OperationBase.php Provides a base class for test operations. 5
OperationData class Drupal\Composer\Plugin\Scaffold\Operations composer/Plugin/Scaffold/Operations/OperationData.php Holds parameter data for operation objects during operation creation only. 1
OperationFactory class Drupal\Composer\Plugin\Scaffold\Operations composer/Plugin/Scaffold/Operations/OperationFactory.php Create Scaffold operation objects based on provided metadata. 1
OperationInterface interface Drupal\Composer\Plugin\Scaffold\Operations composer/Plugin/Scaffold/Operations/OperationInterface.php Interface for scaffold operation objects. 1 1
Operations class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Operations.php Provides a render element for a set of operations links.
Opml class Drupal\views\Plugin\views\style core/modules/views/src/Plugin/views/style/Opml.php Default style plugin to render an OPML feed.
OpmlFields class Drupal\views\Plugin\views\row core/modules/views/src/Plugin/views/row/OpmlFields.php Renders an OPML item based on fields.

Other projects

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