Classes, traits, and interfaces - 10.3.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 1518

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
BlockDeleteForm		class	Drupal\block\Form	core/modules/block/src/Form/BlockDeleteForm.php	Provides a deletion confirmation form for the block instance deletion form.
BlockDemoTest		class	Drupal\Tests\block\Functional	core/modules/block/tests/src/Functional/BlockDemoTest.php	Tests the block demo page with admin themes.
BlockDependenciesTest		class	Drupal\Tests\views\Kernel\Plugin	core/modules/views/tests/src/Kernel/Plugin/BlockDependenciesTest.php	Tests views block config dependencies functionality.
BlockDragTest		class	Drupal\Tests\block\FunctionalJavascript	core/modules/block/tests/src/FunctionalJavascript/BlockDragTest.php	Tests drag and drop blocks on block layout page.
BlockedIp		class	Drupal\ban\Plugin\migrate\destination	core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php	Destination for blocked IP addresses.		1
BlockedIps		class	Drupal\ban\Plugin\migrate\source\d7	core/modules/ban/src/Plugin/migrate/source/d7/BlockedIps.php	Drupal 7 blocked IPs source from database.
BlockedIpsTest		class	Drupal\Tests\ban\Kernel\Plugin\migrate\source\d7	core/modules/ban/tests/src/Kernel/Plugin/migrate/source/d7/BlockedIpsTest.php	Tests D7 blocked_ip source plugin.
BlockEntitySettingTrayForm		class	Drupal\settings_tray\Block	core/modules/settings_tray/src/Block/BlockEntitySettingTrayForm.php	Provides form for block instance forms when used in the off-canvas dialog.		1
BlockExposedFilterAJAXTest		class	Drupal\Tests\views\FunctionalJavascript	core/modules/views/tests/src/FunctionalJavascript/BlockExposedFilterAJAXTest.php	Tests the exposed filter ajax functionality in a block.
BlockFilterTest		class	Drupal\Tests\layout_builder\FunctionalJavascript	core/modules/layout_builder/tests/src/FunctionalJavascript/BlockFilterTest.php	Tests the JavaScript functionality of the block add filter.
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 @group block
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	11
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\tour\Functional\Block	core/modules/tour/tests/src/Functional/Block/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	12
BlockManagerTest		class	Drupal\Tests\Core\Block	core/tests/Drupal/Tests/Core/Block/BlockManagerTest.php	@coversDefaultClass \Drupal\Core\Block\BlockManager
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.		1
BlockPageVariantTest		class	Drupal\Tests\block\Unit\Plugin\DisplayVariant	core/modules/block/tests/src/Unit/Plugin/DisplayVariant/BlockPageVariantTest.php	@coversDefaultClass \Drupal\block\Plugin\DisplayVariant\BlockPageVariant @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 @group settings_tray
BlockPluginId		class	Drupal\block\Plugin\migrate\process	core/modules/block/src/Plugin/migrate/process/BlockPluginId.php
BlockPluginInterface		interface	Drupal\Core\Block	core/lib/Drupal/Core/Block/BlockPluginInterface.php	Defines the required interface for all block plugins.	6	21	1
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			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 @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.

Other projects

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