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 1519

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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 @coversDefaultClass \Drupal\Core\Authentication\AuthenticationCollector[[api-linebreak]] @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[[api-linebreak]] @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[[api-linebreak]] @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.
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.
AutomatedCronTest class Drupal\Tests\automated_cron\Kernel core/modules/automated_cron/tests/src/Kernel/AutomatedCronTest.php Tests 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. 3
AvifImageEffect class Drupal\image\Plugin\ImageEffect core/modules/image/src/Plugin/ImageEffect/AvifImageEffect.php Converts an image resource to AVIF, with fallback.
BackendChain class Drupal\Core\Cache core/lib/Drupal/Core/Cache/BackendChain.php Defines a chained cache implementation for combining multiple cache backends. 2 6
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
BackendCompilerPassTest class Drupal\Tests\Core\DependencyInjection\Compiler core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php @coversDefaultClass \Drupal\Core\DependencyInjection\Compiler\BackendCompilerPass[[api-linebreak]] @group DependencyInjection
BackwardsCompatibilityClassLoader final class Drupal\Core\ClassLoader core/lib/Drupal/Core/ClassLoader/BackwardsCompatibilityClassLoader.php Adds backwards compatibility support for deprecated classes. 1
BackwardsCompatibilityClassLoaderPass class Drupal\Core\DependencyInjection\Compiler core/lib/Drupal/Core/DependencyInjection/Compiler/BackwardsCompatibilityClassLoaderPass.php Compiler pass to merge moved classes into a single container parameter. 1
BackwardsCompatibilityClassLoaderTest class Drupal\KernelTests\Core\ClassLoader core/tests/Drupal/KernelTests/Core/ClassLoader/BackwardsCompatibilityClassLoaderTest.php @coversDefaultClass Drupal\Core\ClassLoader\BackwardsCompatibilityClassLoader[[api-linebreak]] @group ClassLoader
BadPluginDefinitionException class Drupal\migrate\Plugin\Exception core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php Defines a class for bad plugin definition exceptions. 5
BaloneySpam class Drupal\block_test\Plugin\Condition core/modules/block/tests/modules/block_test/src/Plugin/Condition/BaloneySpam.php Provides a 'baloney_spam' condition.
BAlterHooks class Drupal\bbb_hook_order_test\Hook core/modules/system/tests/modules/HookOrder/bbb_hook_order_test/src/Hook/BAlterHooks.php This class contains hook implementations. 1
BanAdmin class Drupal\ban\Form core/modules/ban/src/Form/BanAdmin.php Displays banned IP addresses. 1 1
BanAdminTest class Drupal\Tests\ban\Unit core/modules/ban/tests/src/Unit/BanAdminTest.php Tests the BanAdmin form.
Banana class Drupal\plugin_test\Plugin\plugin_test\fruit core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/Banana.php Plugin annotation @Plugin( id = "banana", label = "Banana", color = "yellow", uses = { "bread" = @Translation("Banana bread"), "loaf" = @PluralTranslation( singular = "@count loaf", plural = "@count loaves" ) } )
BanDelete class Drupal\ban\Form core/modules/ban/src/Form/BanDelete.php Provides a form to unban IP addresses. 1
BanHooks class Drupal\ban\Hook core/modules/ban/src/Hook/BanHooks.php Hook implementations for ban.
BanIpManager class Drupal\ban core/modules/ban/src/BanIpManager.php Ban IP manager. 1 2
BanIpManagerInterface interface Drupal\ban core/modules/ban/src/BanIpManagerInterface.php Provides an interface defining a BanIp manager. 1 5
BanIpTest class Drupal\Tests\ban\Kernel core/modules/ban/tests/src/Kernel/BanIpTest.php @group ban
BanMiddleware class Drupal\ban core/modules/ban/src/BanMiddleware.php Provides a HTTP middleware to implement IP based banning. 1 2
BanMiddlewareTest class Drupal\Tests\ban\Unit core/modules/ban/tests/src/Unit/BanMiddlewareTest.php @coversDefaultClass \Drupal\ban\BanMiddleware[[api-linebreak]] @group ban

Other projects

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