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
BigApple class Drupal\plugin_test_extended\Plugin\plugin_test\fruit core/modules/system/tests/modules/plugin_test_extended/src/Plugin/plugin_test/fruit/BigApple.php Plugin annotation @PluginExtended( id = "big_apple", label = "Big Apple", color = "green" )
BigPipe class Drupal\big_pipe\Render core/modules/big_pipe/src/Render/BigPipe.php Service for sending an HTML response in chunks (to get faster page loads). 5 2
BigPipeBypassJsHooks class Drupal\big_pipe_bypass_js\Hook core/modules/big_pipe/tests/modules/big_pipe_bypass_js/src/Hook/BigPipeBypassJsHooks.php Hook implementations for big_pipe_bypass_js.
BigPipeController class Drupal\big_pipe\Controller core/modules/big_pipe/src/Controller/BigPipeController.php Returns responses for BigPipe module routes.
BigPipeHooks class Drupal\big_pipe\Hook core/modules/big_pipe/src/Hook/BigPipeHooks.php Hook implementations for big_pipe.
BigPipeInterfacePreviewThemeSuggestionsTest class Drupal\Tests\big_pipe\Kernel core/modules/big_pipe/tests/src/Kernel/BigPipeInterfacePreviewThemeSuggestionsTest.php Tests the big_pipe_theme_suggestions_big_pipe_interface_preview() function.
BigPipeMarkup final class Drupal\big_pipe\Render core/modules/big_pipe/src/Render/BigPipeMarkup.php Defines an object that passes safe strings through BigPipe's render pipeline. 3
BigPipePlaceholderTestCase class Drupal\big_pipe_test core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php
BigPipePlaceholderTestCases class Drupal\big_pipe_test core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php BigPipe placeholder test cases for use in both unit and integration tests. 2
BigPipePreviewTest class Drupal\Tests\big_pipe\FunctionalJavascript core/modules/big_pipe/tests/src/FunctionalJavascript/BigPipePreviewTest.php Tests placeholder preview functionality.
BigPipeRegressionTest class Drupal\Tests\big_pipe\FunctionalJavascript core/modules/big_pipe/tests/src/FunctionalJavascript/BigPipeRegressionTest.php BigPipe regression tests.
BigPipeRegressionTestController class Drupal\big_pipe_regression_test core/modules/big_pipe/tests/modules/big_pipe_regression_test/src/BigPipeRegressionTestController.php 1
BigPipeRegressionTestHooks class Drupal\big_pipe_regression_test\Hook core/modules/big_pipe/tests/modules/big_pipe_regression_test/src/Hook/BigPipeRegressionTestHooks.php Hook implementations for big_pipe_regression_test.
BigPipeResponse class Drupal\big_pipe\Render core/modules/big_pipe/src/Render/BigPipeResponse.php A response that is sent in chunks by the BigPipe service. 6
BigPipeResponseAttachmentsProcessor class Drupal\big_pipe\Render core/modules/big_pipe/src/Render/BigPipeResponseAttachmentsProcessor.php Processes attachments of HTML responses with BigPipe enabled. 1 2
BigPipeResponseAttachmentsProcessorTest class Drupal\Tests\big_pipe\Unit\Render core/modules/big_pipe/tests/src/Unit/Render/BigPipeResponseAttachmentsProcessorTest.php @coversDefaultClass \Drupal\big_pipe\Render\BigPipeResponseAttachmentsProcessor @group big_pipe
BigPipeStrategy class Drupal\big_pipe\Render\Placeholder core/modules/big_pipe/src/Render/Placeholder/BigPipeStrategy.php Defines the BigPipe placeholder strategy, to send HTML in chunks. 4 2
BigPipeStrategyTest class Drupal\Tests\big_pipe\Unit\Render\Placeholder core/modules/big_pipe/tests/src/Unit/Render/Placeholder/BigPipeStrategyTest.php @coversDefaultClass \Drupal\big_pipe\Render\Placeholder\BigPipeStrategy @group big_pipe
BigPipeTest class Drupal\Tests\big_pipe\Functional core/modules/big_pipe/tests/src/Functional/BigPipeTest.php Tests BigPipe's no-JS detection & response delivery (with and without JS).
BigPipeTestController class Drupal\big_pipe_test core/modules/big_pipe/tests/modules/big_pipe_test/src/BigPipeTestController.php Returns responses for Big Pipe routes.
BigPipeTestForm class Drupal\big_pipe_test\Form core/modules/big_pipe/tests/modules/big_pipe_test/src/Form/BigPipeTestForm.php Form to test BigPipe.
BigPipeTestHooks class Drupal\big_pipe_test\Hook core/modules/big_pipe/tests/modules/big_pipe_test/src/Hook/BigPipeTestHooks.php Hook implementations for big_pipe_test.
BigPipeTestSubscriber class Drupal\big_pipe_test\EventSubscriber core/modules/big_pipe/tests/modules/big_pipe_test/src/EventSubscriber/BigPipeTestSubscriber.php 1 2
BinaryData class Drupal\Core\TypedData\Plugin\DataType core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php The binary data type.
BinaryFileResponseTest class Drupal\KernelTests\Core\Http core/tests/Drupal/KernelTests/Core/Http/BinaryFileResponseTest.php Tests the headers added by BinaryFileResponse.
BinaryFileResponseTestController class Drupal\binary_file_response_test\Controller core/modules/system/tests/modules/binary_file_response_test/src/Controller/BinaryFileResponseTestController.php Controller routines for binary file response tests.
BinaryInterface interface Drupal\Core\TypedData\Type core/lib/Drupal/Core/TypedData/Type/BinaryInterface.php Interface for binary data. 1 3
Blackcurrant class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityTypeRepositoryTest.php
BlankLayout class Drupal\layout_builder\Plugin\Layout core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php Provides a layout plugin that produces no output.
Block class Drupal\views\Plugin\views\display core/modules/views/src/Plugin/views/display/Block.php The plugin that handles a block.
Block class Drupal\block\Entity core/modules/block/src/Entity/Block.php Defines a Block configuration entity class. 50 1
Block class Drupal\block\Plugin\migrate\source core/modules/block/src/Plugin/migrate/source/Block.php Drupal 6/7 block source from database. 2 2
Block class Drupal\Core\Block\Attribute core/lib/Drupal/Core/Block/Attribute/Block.php The Block attribute. 56
Block class Drupal\Core\Block\Annotation core/lib/Drupal/Core/Block/Annotation/Block.php Defines a Block annotation object.
BlockAccessControlHandler class Drupal\block core/modules/block/src/BlockAccessControlHandler.php Defines the access control handler for the content block entity type. 1
BlockAddController class Drupal\block\Controller core/modules/block/src/Controller/BlockAddController.php Controller for building the block instance add form.
BlockAddTest class Drupal\Tests\block\FunctionalJavascript core/modules/block/tests/src/FunctionalJavascript/BlockAddTest.php Tests the JS functionality in the block add form.
BlockAdminThemeTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockAdminThemeTest.php Tests the block system with admin themes.
BlockBase abstract class Drupal\Core\Block core/lib/Drupal/Core/Block/BlockBase.php Defines a base block implementation that most blocks plugins will extend. 53 54
BlockBaseTest class Drupal\Tests\Core\Block core/tests/Drupal/Tests/Core/Block/BlockBaseTest.php @coversDefaultClass \Drupal\Core\Block\BlockBase @group block
BlockCacheTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockCacheTest.php Tests block caching.
BlockComponentRenderArray class Drupal\layout_builder\EventSubscriber core/modules/layout_builder/src/EventSubscriber/BlockComponentRenderArray.php Builds render arrays and handles access for all block components. 2 2
BlockComponentRenderArrayTest class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/BlockComponentRenderArrayTest.php @coversDefaultClass \Drupal\layout_builder\EventSubscriber\BlockComponentRenderArray @group layout_builder
BlockConfigEntityUnitTest class Drupal\Tests\block\Unit core/modules/block/tests/src/Unit/BlockConfigEntityUnitTest.php @coversDefaultClass \Drupal\block\Entity\Block @group block
BlockConfigSchemaTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockConfigSchemaTest.php Tests the block config schema.
BlockConfigSchemaTest class Drupal\Tests\book\Kernel\Block core/modules/book/tests/src/Kernel/Block/BlockConfigSchemaTest.php Tests the block config schema.
BlockContent class Drupal\block_content\Entity core/modules/block_content/src/Entity/BlockContent.php Defines the content block entity class. 39
BlockContent class Drupal\block_content\Plugin\views\wizard core/modules/block_content/src/Plugin/views/wizard/BlockContent.php Used for creating 'block_content' views with the wizard.
BlockContent class Drupal\block_content\Plugin\Derivative core/modules/block_content/src/Plugin/Derivative/BlockContent.php Retrieves block plugin definitions for all content blocks. 2
BlockContentAccessControlHandler class Drupal\block_content core/modules/block_content/src/BlockContentAccessControlHandler.php Defines the access control handler for the content block entity type. 2

Other projects

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