Classes, traits, and interfaces - 9.5.x - drupal

Primary tabs

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 1523

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
AssetResolverInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetResolverInterface.php Resolves asset libraries into concrete CSS and JavaScript assets. 1 4
AssetResolverTest class Drupal\Tests\Core\Asset core/tests/Drupal/Tests/Core/Asset/AssetResolverTest.php @coversDefaultClass \Drupal\Core\Asset\AssetResolver @group Asset
AssignOwnerNode class Drupal\node\Plugin\Action core/modules/node/src/Plugin/Action/AssignOwnerNode.php Assigns ownership of a node to a user.
AttachedAssets class Drupal\Core\Asset core/lib/Drupal/Core/Asset/AttachedAssets.php The default attached assets collection. 10
AttachedAssetsInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AttachedAssetsInterface.php The attached assets collection for the current response. 1 9
AttachedAssetsTest class Drupal\KernelTests\Core\Asset core/tests/Drupal/KernelTests/Core/Asset/AttachedAssetsTest.php Tests #attached assets: attached asset libraries and JavaScript settings.
AttachedRenderingBlock class Drupal\render_attached_test\Plugin\Block core/modules/system/tests/modules/render_attached_test/src/Plugin/Block/AttachedRenderingBlock.php A block we can use to test caching of #attached headers.
Attachment class Drupal\views\Plugin\views\display core/modules/views/src/Plugin/views/display/Attachment.php The plugin that handles an attachment display.
AttachmentsInterface interface Drupal\Core\Render core/lib/Drupal/Core/Render/AttachmentsInterface.php Defines an interface for responses that can expose #attached metadata. 5 11
AttachmentsResponseProcessorInterface interface Drupal\Core\Render core/lib/Drupal/Core/Render/AttachmentsResponseProcessorInterface.php Defines an interface for processing attachments of responses that have them. 2 5
AttachmentsTestDomainObject class Drupal\early_rendering_controller_test core/modules/system/tests/modules/early_rendering_controller_test/src/AttachmentsTestDomainObject.php
AttachmentsTestResponse class Drupal\early_rendering_controller_test core/modules/system/tests/modules/early_rendering_controller_test/src/AttachmentsTestResponse.php
AttachmentsTrait trait Drupal\Core\Render core/lib/Drupal/Core/Render/AttachmentsTrait.php Provides an implementation of AttachmentsInterface. 3
AttachmentTestFormatter class Drupal\views_test_formatter\Plugin\Field\FieldFormatter core/modules/views/tests/modules/views_test_formatter/src/Plugin/Field/FieldFormatter/AttachmentTestFormatter.php Plugin implementation of the 'number_unformatted_with_attachment' formatter.
Attribute class Drupal\Core\Template core/lib/Drupal/Core/Template/Attribute.php Collects, sanitizes, and renders HTML attributes. 1 37
AttributeArray class Drupal\Core\Template core/lib/Drupal/Core/Template/AttributeArray.php A class that defines a type of Attribute that can be added to as an array. 1
AttributeBoolean class Drupal\Core\Template core/lib/Drupal/Core/Template/AttributeBoolean.php A class that defines a type of boolean HTML attribute.
AttributeHelper class Drupal\Core\Template core/lib/Drupal/Core/Template/AttributeHelper.php Helper class to deal with mixed array and Attribute operations. 2
AttributeHelperTest class Drupal\Tests\Core\Template core/tests/Drupal/Tests/Core/Template/AttributeHelperTest.php @coversDefaultClass \Drupal\Core\Template\AttributeHelper @group Template
AttributesTest class Drupal\Tests\Core\Common core/tests/Drupal/Tests/Core/Common/AttributesTest.php Tests the Drupal\Core\Template\Attribute functionality.
AttributeString class Drupal\Core\Template core/lib/Drupal/Core/Template/AttributeString.php A class that represents most standard HTML attributes. 1
AttributeTest class Drupal\Tests\Core\Template core/tests/Drupal/Tests/Core/Template/AttributeTest.php @coversDefaultClass \Drupal\Core\Template\Attribute @group Template
AttributeValueBase abstract class Drupal\Core\Template core/lib/Drupal/Core/Template/AttributeValueBase.php Defines the base class for an attribute type. 3
AudioFile class Drupal\media\Plugin\media\Source core/modules/media/src/Plugin/media/Source/AudioFile.php Media source wrapping around an audio file.
AuditException class Drupal\migrate\Audit core/modules/migrate/src/Audit/AuditException.php Defines an exception to throw if an error occurs during a migration audit.
AuditorInterface interface Drupal\migrate\Audit core/modules/migrate/src/Audit/AuditorInterface.php Defines an interface for migration auditors. 1
AuditResult class Drupal\migrate\Audit core/modules/migrate/src/Audit/AuditResult.php Encapsulates the result of a migration audit. 4
Auth class Drupal\early_translation_test core/modules/locale/tests/modules/early_translation_test/src/Auth.php Test authentication provider. 2
AuthenticationCollector class Drupal\Core\Authentication core/lib/Drupal/Core/Authentication/AuthenticationCollector.php A collector class for authentication providers. 2 2
AuthenticationCollectorInterface interface Drupal\Core\Authentication core/lib/Drupal/Core/Authentication/AuthenticationCollectorInterface.php Interface for collectors of registered authentication providers. 1
AuthenticationCollectorTest class Drupal\Tests\Core\Authentication core/tests/Drupal/Tests/Core/Authentication/AuthenticationCollectorTest.php @coversDefaultClass \Drupal\Core\Authentication\AuthenticationCollector @group Authentication
AuthenticationManager class Drupal\Core\Authentication core/lib/Drupal/Core/Authentication/AuthenticationManager.php Manager for authentication. 1 2
AuthenticationManagerTest class Drupal\Tests\Core\Authentication core/tests/Drupal/Tests/Core/Authentication/AuthenticationManagerTest.php @coversDefaultClass \Drupal\Core\Authentication\AuthenticationManager @group Authentication
AuthenticationProviderChallengeInterface interface Drupal\Core\Authentication core/lib/Drupal/Core/Authentication/AuthenticationProviderChallengeInterface.php Generate a challenge when access is denied for unauthenticated users. 2 2
AuthenticationProviderFilterInterface interface Drupal\Core\Authentication core/lib/Drupal/Core/Authentication/AuthenticationProviderFilterInterface.php Restrict authentication methods to a subset of the site. 2 2
AuthenticationProviderInterface interface Drupal\Core\Authentication core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php Interface for authentication providers. 8 8
AuthenticationProviderPass class Drupal\Core\DependencyInjection\Compiler core/lib/Drupal/Core/DependencyInjection/Compiler/AuthenticationProviderPass.php Registers the authentication_providers container parameter. 2
AuthenticationProviderPassTest class Drupal\Tests\Core\DependencyInjection\Compiler core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/AuthenticationProviderPassTest.php @coversDefaultClass \Drupal\Core\DependencyInjection\Compiler\AuthenticationProviderPass @group DependencyInjection
AuthenticationSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/AuthenticationSubscriber.php Authentication subscriber. 2
AuthorFormatter class Drupal\user\Plugin\Field\FieldFormatter core/modules/user/src/Plugin/Field/FieldFormatter/AuthorFormatter.php Plugin implementation of the 'author' formatter.
AuthorNameFormatter class Drupal\comment\Plugin\Field\FieldFormatter core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php Plugin implementation of the 'comment_username' formatter.
AutocompleteController class Drupal\form_test core/modules/system/tests/modules/form_test/src/AutocompleteController.php Defines a controller class with methods for autocompletion.
AutoIncrementingTestItem class Drupal\entity_test\Plugin\Field\FieldType core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/AutoIncrementingTestItem.php Defines the 'field_method_invocation_order_test' entity field type.
Autoload class Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Annotation core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Annotation/Autoload.php
AutomatedCron class Drupal\automated_cron\EventSubscriber core/modules/automated_cron/src/EventSubscriber/AutomatedCron.php A subscriber running cron after a response is sent. 2
AutowireTest class Drupal\KernelTests\Core\DependencyInjection core/tests/Drupal/KernelTests/Core/DependencyInjection/AutowireTest.php Tests auto-wiring services.
BackendChain class Drupal\Core\Cache core/lib/Drupal/Core/Cache/BackendChain.php Defines a chained cache implementation for combining multiple cache backends. 2 4
BackendChainImplementationUnitTest class Drupal\Tests\Core\Cache core/tests/Drupal/Tests/Core/Cache/BackendChainImplementationUnitTest.php Unit test of backend chain implementation specifics.
BackendChainTest class Drupal\KernelTests\Core\Cache core/tests/Drupal/KernelTests/Core/Cache/BackendChainTest.php Unit test of the backend chain using the generic cache unit test base.
BackendCompilerPass class Drupal\Core\DependencyInjection\Compiler core/lib/Drupal/Core/DependencyInjection/Compiler/BackendCompilerPass.php Defines a compiler pass to allow automatic override per backend. 2

Other projects


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