Classes, traits, and interfaces - 9.5.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 1523

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
BlockFilterTest class Drupal\Tests\block\FunctionalJavascript core/modules/block/tests/src/FunctionalJavascript/BlockFilterTest.php Tests the JavaScript functionality of the block add filter. 1 1
BlockForm class Drupal\block core/modules/block/src/BlockForm.php Provides form for block instance forms. 1 2
BlockFormInBlockTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockFormInBlockTest.php Tests form in block caching.
BlockFormMessagesTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/BlockFormMessagesTest.php Tests that messages appear in the off-canvas dialog with configuring blocks.
BlockFormTest class Drupal\Tests\block\Unit core/modules/block/tests/src/Unit/BlockFormTest.php @coversDefaultClass \Drupal\block\BlockForm[[api-linebreak]] @group block
BlockHalJsonAnonTest class Drupal\Tests\hal\Functional\block core/modules/hal/tests/src/Functional/block/BlockHalJsonAnonTest.php @group hal @group legacy
BlockHalJsonBasicAuthTest class Drupal\Tests\hal\Functional\block core/modules/hal/tests/src/Functional/block/BlockHalJsonBasicAuthTest.php @group hal @group legacy
BlockHalJsonCookieTest class Drupal\Tests\hal\Functional\block core/modules/hal/tests/src/Functional/block/BlockHalJsonCookieTest.php @group hal @group legacy
BlockHasOverridesAccessCheck class Drupal\settings_tray\Access core/modules/settings_tray/src/Access/BlockHasOverridesAccessCheck.php Determines whether the requested block has a 'settings_tray' form. 2
BlockHiddenRegionTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockHiddenRegionTest.php Tests that blocks are not added to hidden regions on theme installation.
BlockHookOperationTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockHookOperationTest.php Tests for Block module regarding hook_entity_operations_alter().
BlockHtmlTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockHtmlTest.php Tests block HTML ID validity.
BlockInstallTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockInstallTest.php Tests block module's installation.
BlockInterface interface Drupal\block core/modules/block/src/BlockInterface.php Provides an interface defining a block entity. 1 7
BlockInterfaceTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockInterfaceTest.php Tests that the block plugin can work properly without a supporting entity.
BlockInvalidRegionTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockInvalidRegionTest.php Tests that blocks assigned to invalid regions are disabled with a warning.
BlockJsonAnonTest class Drupal\Tests\block\Functional\Rest core/modules/block/tests/src/Functional/Rest/BlockJsonAnonTest.php @group rest
BlockJsonBasicAuthTest class Drupal\Tests\block\Functional\Rest core/modules/block/tests/src/Functional/Rest/BlockJsonBasicAuthTest.php @group rest
BlockJsonCookieTest class Drupal\Tests\block\Functional\Rest core/modules/block/tests/src/Functional/Rest/BlockJsonCookieTest.php @group rest
BlockLanguageCacheTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockLanguageCacheTest.php Tests display of menu blocks with multiple languages.
BlockLanguageTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockLanguageTest.php Tests per-language block configuration.
BlockLayoutTourTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockLayoutTourTest.php Tests the Block Layout tour.
BlockLibraryController class Drupal\block\Controller core/modules/block/src/Controller/BlockLibraryController.php Provides a list of block plugins to be added to the layout.
BlockListBuilder class Drupal\block core/modules/block/src/BlockListBuilder.php Defines a class to build a listing of block entities.
BlockListController class Drupal\block\Controller core/modules/block/src/Controller/BlockListController.php Defines a controller to list blocks.
BlockLocalTasksTest class Drupal\Tests\block\Unit\Menu core/modules/block/tests/src/Unit/Menu/BlockLocalTasksTest.php Tests block local tasks.
BlockManager class Drupal\Core\Block core/lib/Drupal/Core/Block/BlockManager.php Manages discovery and instantiation of block plugins. 1 2
BlockManagerInterface interface Drupal\Core\Block core/lib/Drupal/Core/Block/BlockManagerInterface.php Provides an interface for the discovery and instantiation of block plugins. 1 10
BlockManagerTest class Drupal\Tests\Core\Block core/tests/Drupal/Tests/Core/Block/BlockManagerTest.php @coversDefaultClass \Drupal\Core\Block\BlockManager[[api-linebreak]]
BlockNodeTypeVisibilityUpdateTest class Drupal\Tests\block\Functional\Update core/modules/block/tests/src/Functional/Update/BlockNodeTypeVisibilityUpdateTest.php Tests the upgrade path for updating the node type visibility condition.
BlockPageDisplayVariantSubscriber class Drupal\block\EventSubscriber core/modules/block/src/EventSubscriber/BlockPageDisplayVariantSubscriber.php Selects the block page display variant. 2
BlockPageVariant class Drupal\block\Plugin\DisplayVariant core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php Provides a page display variant that decorates the main content with blocks.
BlockPageVariantTest class Drupal\Tests\block\Unit\Plugin\DisplayVariant core/modules/block/tests/src/Unit/Plugin/DisplayVariant/BlockPageVariantTest.php @coversDefaultClass \Drupal\block\Plugin\DisplayVariant\BlockPageVariant[[api-linebreak]] @group block
BlockPluginCollection class Drupal\block core/modules/block/src/BlockPluginCollection.php Provides a collection of block plugins. 1
BlockPluginHasSettingsTrayFormAccessCheck class Drupal\settings_tray\Access core/modules/settings_tray/src/Access/BlockPluginHasSettingsTrayFormAccessCheck.php Determines whether the requested block has a 'settings_tray' form. 1 2
BlockPluginHasSettingsTrayFormAccessCheckTest class Drupal\Tests\settings_tray\Unit\Access core/modules/settings_tray/tests/src/Unit/Access/BlockPluginHasSettingsTrayFormAccessCheckTest.php @coversDefaultClass \Drupal\settings_tray\Access\BlockPluginHasSettingsTrayFormAccessCheck[[api-linebreak]] @group settings_tray
BlockPluginId class Drupal\block\Plugin\migrate\process core/modules/block/src/Plugin/migrate/process/BlockPluginId.php Plugin annotation @MigrateProcessPlugin( id = "block_plugin_id" )
BlockPluginInterface interface Drupal\Core\Block core/lib/Drupal/Core/Block/BlockPluginInterface.php Defines the required interface for all block plugins. 6 19
BlockPluginTrait trait Drupal\Core\Block core/lib/Drupal/Core/Block/BlockPluginTrait.php Provides the base implementation of a block plugin. 1
BlockRebuildTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockRebuildTest.php Tests block_rebuild().
BlockRegion class Drupal\block\Plugin\migrate\process core/modules/block/src/Plugin/migrate/process/BlockRegion.php Plugin annotation @MigrateProcessPlugin( id = "block_region" ) 1
BlockRegionTest class Drupal\Tests\block\Unit\Plugin\migrate\process core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockRegionTest.php @coversDefaultClass \Drupal\block\Plugin\migrate\process\BlockRegion[[api-linebreak]] @group block
BlockRenderAlterContent class Drupal\block_test core/modules/block/tests/modules/block_test/src/BlockRenderAlterContent.php Implements a trusted preRender callback.
BlockRenderOrderTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockRenderOrderTest.php Tests blocks are being rendered in order by weight.
BlockRepository class Drupal\block core/modules/block/src/BlockRepository.php Provides a repository for Block config entities. 1 2
BlockRepositoryInterface interface Drupal\block core/modules/block/src/BlockRepositoryInterface.php 1 1
BlockRepositoryTest class Drupal\Tests\block\Unit core/modules/block/tests/src/Unit/BlockRepositoryTest.php @coversDefaultClass \Drupal\block\BlockRepository[[api-linebreak]] @group block
BlockResourceTestBase abstract class Drupal\Tests\block\Functional\Rest core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php 9 3
BlockSettings class Drupal\block\Plugin\migrate\process core/modules/block/src/Plugin/migrate/process/BlockSettings.php Plugin annotation @MigrateProcessPlugin( id = "block_settings" ) 1
BlockSettingsTest class Drupal\Tests\block\Unit\Plugin\migrate\process core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockSettingsTest.php @coversDefaultClass \Drupal\block\Plugin\migrate\process\BlockSettings[[api-linebreak]] @group block

Other projects

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