Classes, traits, and interfaces - 11.x - 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 1518

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
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.	3	1
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	@coversDefaultClass \Drupal\Component\Plugin\Attribute\AttributeBase @group Attribute
AttributeBoolean		class	Drupal\Core\Template	core/lib/Drupal/Core/Template/AttributeBoolean.php	A class that defines a type of boolean HTML attribute.
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	@coversDefaultClass \Drupal\Component\Annotation\Plugin\Discovery\AnnotationBridgeDecorator @group Plugin
AttributeClass		final class	Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Attribute	core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Attribute/AttributeClass.php
AttributeClassDiscovery		class	Drupal\Core\Plugin\Discovery	core/lib/Drupal/Core/Plugin/Discovery/AttributeClassDiscovery.php	Defines a discovery mechanism to find plugins using attributes.	1	1
AttributeClassDiscovery		class	Drupal\Component\Plugin\Discovery	core/lib/Drupal/Component/Plugin/Discovery/AttributeClassDiscovery.php	Defines a discovery mechanism to find plugins with attributes.	1	3
AttributeClassDiscoveryCachedTest		class	Drupal\Tests\Component\Plugin\Attribute	core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeClassDiscoveryCachedTest.php	@coversDefaultClass \Drupal\Component\Plugin\Discovery\AttributeClassDiscovery @group Attribute @runTestsInSeparateProcesses
AttributeClassDiscoveryTest		class	Drupal\Tests\Component\Plugin\Attribute	core/tests/Drupal/Tests/Component/Plugin/Attribute/AttributeClassDiscoveryTest.php	@coversDefaultClass \Drupal\Component\Plugin\Discovery\AttributeClassDiscovery @group Attribute @runTestsInSeparateProcesses
AttributeDiscoveryTest1		class	com\example\PluginNamespace	core/tests/Drupal/Tests/Component/Plugin/Attribute/Fixtures/Plugins/PluginNamespace/AttributeDiscoveryTest1.php	Provides a custom test plugin.
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/Drupal/Tests/Component/Plugin/Attribute/Fixtures/Plugins/PluginNamespace/AttributeDiscoveryTest2.php	Provides a custom test plugin that extends from a missing dependency.
AttributeDiscoveryTest2		class	com\example\PluginNamespace	core/tests/fixtures/plugins/Plugin/PluginNamespace/AttributeDiscoveryTest2.php	Provides a custom test plugin that extends from a missing dependency.
AttributeDiscoveryWithAnnotations		class	Drupal\Core\Plugin\Discovery	core/lib/Drupal/Core/Plugin/Discovery/AttributeDiscoveryWithAnnotations.php	Enables both attribute and annotation discovery for plugin definitions.		3
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
AttributeInterface		interface	Drupal\Component\Plugin\Attribute	core/lib/Drupal/Component/Plugin/Attribute/AttributeInterface.php	Defines a common interface for classed attributes.	1	4
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.		2
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.		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
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
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.
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
AutomatedCron		class	Drupal\automated_cron\EventSubscriber	core/modules/automated_cron/src/EventSubscriber/AutomatedCron.php	A subscriber running cron after a response is sent.			2
AutomatedCronHooks		class	Drupal\automated_cron\Hook	core/modules/automated_cron/src/Hook/AutomatedCronHooks.php	Hook implementations for automated_cron.
AutowireTest		class	Drupal\KernelTests\Core\DependencyInjection	core/tests/Drupal/KernelTests/Core/DependencyInjection/AutowireTest.php	Tests auto-wiring services.
AutowireTrait		trait	Drupal\Core\DependencyInjection	core/lib/Drupal/Core/DependencyInjection/AutowireTrait.php	Defines a trait for automatically wiring dependencies from the container.		1

Other projects

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