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

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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 Test domain class with implemented AttachmentsInterface.
AttachmentsTestResponse class Drupal\early_rendering_controller_test core/modules/system/tests/modules/early_rendering_controller_test/src/AttachmentsTestResponse.php Test response with implemented AttachmentsInterface.
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 48 12
Attribute final class Drupal\Component\Annotation\Doctrine\Annotation core/lib/Drupal/Component/Annotation/Doctrine/Annotation/Attribute.php Annotation that can be used to signal to the parser to check the attribute type during the parsing process. 1
AttributeAllowTestClass class Drupal\Tests\Core\Template core/tests/Drupal/Tests/Core/Template/TwigSandboxTest.php Test class for TwigAllowed attribute.
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
AttributeBase abstract class Drupal\Component\Plugin\Attribute core/lib/Drupal/Component/Plugin/Attribute/AttributeBase.php Provides a base class for classed attributes. 4 2
AttributeBaseStub class Drupal\Tests\Component\Plugin\Attribute core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeBaseTest.php
AttributeBaseTest class Drupal\Tests\Component\Plugin\Attribute core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeBaseTest.php Tests Drupal\Component\Plugin\Attribute\AttributeBase.
AttributeBoolean class Drupal\Core\Template core/lib/Drupal/Core/Template/AttributeBoolean.php A class that defines a type of boolean HTML attribute. 1
AttributeBridgeDecorator class Drupal\Component\Plugin\Discovery core/lib/Drupal/Component/Plugin/Discovery/AttributeBridgeDecorator.php Ensures that all definitions are run through the attribute process. 3
AttributeBridgeDecoratorTest class Drupal\Tests\Component\Plugin\Discovery core/tests/Drupal/Tests/Component/Plugin/Discovery/AttributeBridgeDecoratorTest.php Tests Drupal\Component\Annotation\Plugin\Discovery\AnnotationBridgeDecorator.
AttributeClass final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Attribute core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Attribute/AttributeClass.php #[\Attribute]
AttributeClassDiscovery class Drupal\Core\Plugin\Discovery core/lib/Drupal/Core/Plugin/Discovery/AttributeClassDiscovery.php Defines a discovery mechanism to find plugins using attributes. 1 2
AttributeClassDiscovery class Drupal\Component\Plugin\Discovery core/lib/Drupal/Component/Plugin/Discovery/AttributeClassDiscovery.php Defines a discovery mechanism to find plugins with attributes. 1 4
AttributeClassDiscoveryCachedTest class Drupal\Tests\Component\Plugin\Attribute core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeClassDiscoveryCachedTest.php Tests Attribute Class Discovery Cached.
AttributeClassDiscoveryTest class Drupal\Tests\Component\Plugin\Attribute core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeClassDiscoveryTest.php Tests Drupal\Component\Plugin\Discovery\AttributeClassDiscovery.
AttributeDiscoveryTest1 class com\example\PluginNamespace core/tests/fixtures/plugins/Plugin/PluginNamespace/AttributeDiscoveryTest1.php Provides a custom test plugin.
AttributeDiscoveryTest2 class com\example\PluginNamespace core/tests/fixtures/plugins/Plugin/PluginNamespace/AttributeDiscoveryTest2.php Provides a custom test plugin that extends from a missing dependency.
AttributeDiscoveryTestMissingInterface class com\example\PluginNamespace core/tests/fixtures/plugins/Plugin/PluginNamespace/AttributeDiscoveryTestMissingInterface.php Provides a custom test plugin that implements a missing interface.
AttributeDiscoveryTestMissingTrait class com\example\PluginNamespace core/tests/fixtures/plugins/Plugin/PluginNamespace/AttributeDiscoveryTestMissingTrait.php Provides a custom test plugin that uses a missing trait.
AttributeDiscoveryWithAnnotations class Drupal\Core\Plugin\Discovery core/lib/Drupal/Core/Plugin/Discovery/AttributeDiscoveryWithAnnotations.php Enables both attribute and annotation discovery for plugin definitions. 1 5
AttributeDiscoveryWithAnnotationsAutomatedProviders class Drupal\migrate\Plugin\Discovery core/modules/migrate/src/Plugin/Discovery/AttributeDiscoveryWithAnnotationsAutomatedProviders.php Enables both attribute and annotation discovery for plugin definitions. 1
AttributeHelper class Drupal\Core\Template core/lib/Drupal/Core/Template/AttributeHelper.php Helper class to deal with mixed array and Attribute operations. 6
AttributeHelperTest class Drupal\Tests\Core\Template core/tests/Drupal/Tests/Core/Template/AttributeHelperTest.php Tests Drupal\Core\Template\AttributeHelper.
AttributeInterface interface Drupal\Component\Plugin\Attribute core/lib/Drupal/Component/Plugin/Attribute/AttributeInterface.php Defines a common interface for classed attributes. 1 4
Attributes final class Drupal\Component\Annotation\Doctrine\Annotation core/lib/Drupal/Component/Annotation/Doctrine/Annotation/Attributes.php Annotation that can be used to signal to the parser to check the types of all declared attributes during the parsing process. 1
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. 3
AttributeTest class Drupal\Tests\Core\Template core/tests/Drupal/Tests/Core/Template/AttributeTest.php Tests Drupal\Core\Template\Attribute.
AttributeValueBase abstract class Drupal\Core\Template core/lib/Drupal/Core/Template/AttributeValueBase.php Defines the base class for an attribute type. 3
AttributeXss final class Drupal\link core/modules/link/src/AttributeXss.php Defines a class for attribute XSS filtering. 3
AttributeXssTest final class Drupal\Tests\link\Unit core/modules/link/tests/src/Unit/AttributeXssTest.php Tests AttributeXss.
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. 2
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 Tests Drupal\Core\Authentication\AuthenticationCollector.
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 Tests Drupal\Core\Authentication\AuthenticationManager.
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

Other projects


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