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
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. 5
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
AttributeRouteDiscovery class Drupal\Core\Routing core/lib/Drupal/Core/Routing/AttributeRouteDiscovery.php Discovers routes using Symfony's Route attribute. 1 3 2
AttributeRouteDiscoveryTest class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/AttributeRouteDiscoveryTest.php Tests \Drupal\Core\Routing\AttributeRouteDiscovery.
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 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
AuthenticationProviderPassTest class Drupal\Tests\Core\DependencyInjection\Compiler core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/AuthenticationProviderPassTest.php Tests Drupal\Core\DependencyInjection\Compiler\AuthenticationProviderPass.
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.
AutoconfigurationTest class Drupal\KernelTests\Core\DependencyInjection core/tests/Drupal/KernelTests/Core/DependencyInjection/AutoconfigurationTest.php Tests autoconfiguration of services.
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 1
AutoloadingStorage class Drupal\Core\Config core/lib/Drupal/Core/Config/AutoloadingStorage.php Defines the autoloading storage. 2
AutomatedCron class Drupal\automated_cron\EventSubscriber core/modules/automated_cron/src/EventSubscriber/AutomatedCron.php A subscriber running cron after a response is sent. 1 2
AutomatedCronHooks class Drupal\automated_cron\Hook core/modules/automated_cron/src/Hook/AutomatedCronHooks.php Hook implementations for automated_cron.
AutomatedCronTest class Drupal\Tests\automated_cron\Kernel core/modules/automated_cron/tests/src/Kernel/AutomatedCronTest.php Tests for automated_cron.
AutomatedCronTest class Drupal\Tests\automated_cron\Functional core/modules/automated_cron/tests/src/Functional/AutomatedCronTest.php Tests for automated_cron.
AutowireBlock class Drupal\autowire_test\Plugin\Block core/modules/system/tests/modules/autowire_test/src/Plugin/Block/AutowireBlock.php Provides a block that can be autowired. 1
AutowireBlockTest class Drupal\KernelTests\Core\Block core/tests/Drupal/KernelTests/Core/Block/AutowireBlockTest.php Tests that blocks can be autowired.
AutowiredInstanceTrait trait Drupal\Core\DependencyInjection core/lib/Drupal/Core/DependencyInjection/AutowiredInstanceTrait.php Defines a base trait for automatically wiring dependency arguments. 3
AutowiredInstanceTraitTest class Drupal\Tests\Core\DependencyInjection core/tests/Drupal/Tests/Core/DependencyInjection/AutowiredInstanceTraitTest.php Tests \Drupal\Core\DependencyInjection\AutowiredInstanceTrait.
AutowireErrorBlock class Drupal\autowire_test\Plugin\Block core/modules/system/tests/modules/autowire_test/src/Plugin/Block/AutowireErrorBlock.php Provides a block that cannot be autowired.
AutowireRequiredParameterTestClass class Drupal\Tests\Core\DependencyInjection core/tests/Drupal/Tests/Core/DependencyInjection/AutowiredInstanceTraitTest.php Test class for autowiring a required parameter.
AutowireRequiredServiceTestClass class Drupal\Tests\Core\DependencyInjection core/tests/Drupal/Tests/Core/DependencyInjection/AutowiredInstanceTraitTest.php Test class for autowiring a required service.
AutowireTest class Drupal\KernelTests\Core\DependencyInjection core/tests/Drupal/KernelTests/Core/DependencyInjection/AutowireTest.php Tests auto-wiring services.
AutowireTestClass class Drupal\Tests\Core\DependencyInjection core/tests/Drupal/Tests/Core/DependencyInjection/AutowiredInstanceTraitTest.php Test class covering service and parameter autowiring scenarios.
AutowireTrait trait Drupal\Core\DependencyInjection core/lib/Drupal/Core/DependencyInjection/AutowireTrait.php Defines a trait for automatically wiring dependencies from the container. 13

Other projects


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