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 1531

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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.
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. 1
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.
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. 4
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 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
BackendCompilerPassTest class Drupal\Tests\Core\DependencyInjection\Compiler core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/BackendCompilerPassTest.php Tests Drupal\Core\DependencyInjection\Compiler\BackendCompilerPass.
BackwardsCompatibilityClassLoader final class Drupal\Core\ClassLoader core/lib/Drupal/Core/ClassLoader/BackwardsCompatibilityClassLoader.php Adds backwards compatibility support for deprecated classes. 2
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 Tests Drupal\Core\ClassLoader\BackwardsCompatibilityClassLoader.
BadPluginDefinitionException class Drupal\migrate\Plugin\Exception core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php Defines a class for bad plugin definition exceptions. 4
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. 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 Tests Ban Ip.
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 Tests Drupal\ban\BanMiddleware.
Bar class Drupal\image_test\Plugin\ImageToolkit\Operation\test core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/Bar.php Builds an image toolkit operation.
BarAccessPolicy class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/AccessPolicyProcessorTest.php A test access policy for 'foo' and 'bar' permissions.
BarAlterAccessPolicy class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/AccessPolicyProcessorTest.php A test access policy that adds a permission if another permission exists.
BarClass class Drupal\Tests\Core\DependencyInjection\Fixture core/tests/Drupal/Tests/Core/DependencyInjection/Fixture/BarClass.php Stub class which acts as a service to test the container. 1
BareHtmlPageRenderer class Drupal\Core\Render core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php Default bare HTML page renderer. 2
BareHtmlPageRenderer class Drupal\Core\ProxyClass\Render core/lib/Drupal/Core/ProxyClass/Render/BareHtmlPageRenderer.php Provides a proxy class for \Drupal\Core\Render\BareHtmlPageRenderer.
BareHtmlPageRendererInterface interface Drupal\Core\Render core/lib/Drupal/Core/Render/BareHtmlPageRendererInterface.php Bare HTML page renderer. 2 4
BarTest abstract class Drupal\Tests\Core\Foo core/tests/PHPStan/fixtures/abstract-test-classes.php @group metadata @coversNothing[[api-linebreak]]
BarTest abstract class Drupal\Tests\Core\Foo core/tests/PHPStan/fixtures/test-classes-with-metadata.php @group metadata @coversNothing[[api-linebreak]]
BaseCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/BaseCommand.php Base command that only exists to simplify AJAX commands.
BaseFieldAccessTest class Drupal\Tests\views\Functional\Entity core/modules/views/tests/src/Functional/Entity/BaseFieldAccessTest.php Tests views base field access.
BaseFieldDefinition class Drupal\Core\Field core/lib/Drupal/Core/Field/BaseFieldDefinition.php A class for defining entity fields. 2 105
BaseFieldDefinitionTest class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/BaseFieldDefinitionTest.php Unit test for BaseFieldDefinition.
BaseFieldDefinitionTest class Drupal\Tests\migrate\Unit\Plugin\migrate\destination core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/EntityTestBase.php Stub class for BaseFieldDefinition.
BaseFieldDefinitionTestBase abstract class Drupal\Tests\Core\Field core/tests/Drupal/Tests/Core/Field/BaseFieldDefinitionTestBase.php Provides setup method for testing base field definitions. 1 1
BaseFieldFileFormatterBase abstract class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php Base class for file formatters, which allow to link to the file download URL. 4

Other projects

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