Classes, traits, and interfaces - 8.9.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 1511

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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
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
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. 3
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[[api-linebreak]] @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[[api-linebreak]] @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
BigPipeTestForm class Drupal\big_pipe_test\Form core/modules/big_pipe/tests/modules/big_pipe_test/src/Form/BigPipeTestForm.php Form to test BigPipe.
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.
BinaryInterface interface Drupal\Core\TypedData\Type core/lib/Drupal/Core/TypedData/Type/BinaryInterface.php Interface for binary data. 1 3
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\Core\Block\Annotation core/lib/Drupal/Core/Block/Annotation/Block.php Defines a Block annotation object.
Block class Drupal\block\Plugin\migrate\source core/modules/block/src/Plugin/migrate/source/Block.php Drupal block source from database. 2 2
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. 35
BlockAccessControlHandler class Drupal\block core/modules/block/src/BlockAccessControlHandler.php Defines the access control handler for the block entity type.
BlockAddController class Drupal\block\Controller core/modules/block/src/Controller/BlockAddController.php Controller for building the block instance 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. 45 46
BlockBaseTest class Drupal\Tests\Core\Block core/tests/Drupal/Tests/Core/Block/BlockBaseTest.php @coversDefaultClass \Drupal\Core\Block\BlockBase[[api-linebreak]] @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[[api-linebreak]] @group layout_builder
BlockConditionMissingSchemaUpdateTest class Drupal\Tests\block\Functional\Update core/modules/block/tests/src/Functional/Update/BlockConditionMissingSchemaUpdateTest.php Tests the upgrade path for block with conditions missing context.
BlockConfigEntityUnitTest class Drupal\Tests\block\Unit core/modules/block/tests/src/Unit/BlockConfigEntityUnitTest.php @coversDefaultClass \Drupal\block\Entity\Block[[api-linebreak]] @group block
BlockConfigSchemaTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockConfigSchemaTest.php Tests the block config schema.
BlockContent class Drupal\block_content\Entity core/modules/block_content/src/Entity/BlockContent.php Defines the custom block entity class. 38
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 custom blocks.
BlockContentAccessControlHandler class Drupal\block_content core/modules/block_content/src/BlockContentAccessControlHandler.php Defines the access control handler for the custom block entity type. 1
BlockContentAccessHandlerTest class Drupal\Tests\block_content\Kernel core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php Tests the block content entity access handler.
BlockContentAddLocalAction class Drupal\block_content\Plugin\Menu\LocalAction core/modules/block_content/src/Plugin/Menu/LocalAction/BlockContentAddLocalAction.php Modifies the 'Add custom block' local action. 1
BlockContentBlock class Drupal\block_content\Plugin\Block core/modules/block_content/src/Plugin/Block/BlockContentBlock.php Defines a generic custom block type.
BlockContentCacheTagsTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentCacheTagsTest.php Tests the Custom Block entity's cache tags.
BlockContentContextualLinksTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentContextualLinksTest.php Tests views contextual links on block content.
BlockContentController class Drupal\block_content\Controller core/modules/block_content/src/Controller/BlockContentController.php
BlockContentCreationTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentCreationTest.php Create a block and test saving it.
BlockContentDeleteForm class Drupal\block_content\Form core/modules/block_content/src/Form/BlockContentDeleteForm.php Provides a confirmation form for deleting a custom block entity.
BlockContentDeletionTest class Drupal\Tests\block_content\Kernel core/modules/block_content/tests/src/Kernel/BlockContentDeletionTest.php Tests that deleting a block clears the cached definitions.
BlockContentDeriverTest class Drupal\Tests\block_content\Kernel core/modules/block_content/tests/src/Kernel/BlockContentDeriverTest.php Tests block content plugin deriver.
BlockContentEntityReferenceSelectionTest class Drupal\Tests\block_content\Kernel core/modules/block_content/tests/src/Kernel/BlockContentEntityReferenceSelectionTest.php Tests EntityReference selection handlers don't return non-reusable blocks.
BlockContentEvents final class Drupal\block_content core/modules/block_content/src/BlockContentEvents.php Defines events for the block_content module. 1
BlockContentFieldFilterTest class Drupal\Tests\block_content\Functional\Views core/modules/block_content/tests/src/Functional/Views/BlockContentFieldFilterTest.php Tests block_content field filters with translations.
BlockContentForm class Drupal\block_content core/modules/block_content/src/BlockContentForm.php Form handler for the custom block edit forms.

Other projects

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