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
BlockContentViewsData		class	Drupal\block_content	core/modules/block_content/src/BlockContentViewsData.php	Provides the views data for the block_content entity type.
BlockContentWizardTest		class	Drupal\Tests\block_content\Functional\Views	core/modules/block_content/tests/src/Functional/Views/BlockContentWizardTest.php	Tests block_content wizard and generic entity integration.
BlockContentXmlAnonTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentXmlAnonTest.php	@group rest
BlockContentXmlBasicAuthTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentXmlBasicAuthTest.php	@group rest
BlockContentXmlCookieTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentXmlCookieTest.php	@group rest
BlockContextMappingUpdateFilledTest		class	Drupal\Tests\block\Functional\Update	core/modules/block/tests/src/Functional/Update/BlockContextMappingUpdateFilledTest.php	Runs BlockContextMappingUpdateTest with a dump filled with content.
BlockContextMappingUpdateTest		class	Drupal\Tests\block\Functional\Update	core/modules/block/tests/src/Functional/Update/BlockContextMappingUpdateTest.php	Tests the upgrade path for block context mapping renames.	1
BlockController		class	Drupal\block\Controller	core/modules/block/src/Controller/BlockController.php	Controller routines for admin block routes.
BlockCreationTrait	in drupal:8.4.0 and is removed from drupal:9.0.0. Use \Drupal\Tests\block\Traits\BlockCreationTrait instead.	trait	Drupal\simpletest	core/modules/simpletest/src/BlockCreationTrait.php	Provides methods to create and place block with default settings.
BlockCreationTrait		trait	Drupal\Tests\block\Traits	core/modules/block/tests/src/Traits/BlockCreationTrait.php	Provides methods to create and place block with default settings.		12
BlockCustom		class	Drupal\block_content\Plugin\migrate\source\d7	core/modules/block_content/src/Plugin/migrate/source/d7/BlockCustom.php	Drupal 7 custom block source from database.
BlockCustomTest		class	Drupal\Tests\block_content\Kernel\Plugin\migrate\source\d7	core/modules/block_content/tests/src/Kernel/Plugin/migrate/source/d7/BlockCustomTest.php	Tests d7_block_custom source plugin.
BlockCustomTranslation		class	Drupal\block_content\Plugin\migrate\source\d7	core/modules/block_content/src/Plugin/migrate/source/d7/BlockCustomTranslation.php	Gets Drupal 7 custom block translation from database.	1	1
BlockCustomTranslationTest		class	Drupal\Tests\block_content\Kernel\Plugin\migrate\source\d7	core/modules/block_content/tests/src/Kernel/Plugin/migrate/source/d7/BlockCustomTranslationTest.php	Tests i18n custom block translations source plugin.
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.
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 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.
BlockEntityOffCanvasFormRouteProcessorBC		class	Drupal\settings_tray\RouteProcessor	core/modules/settings_tray/src/RouteProcessor/BlockEntityOffCanvasFormRouteProcessorBC.php	Processes the Block entity off-canvas form BC route.			2
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
BlockHalJsonAnonTest		class	Drupal\Tests\block\Functional\Hal	core/modules/block/tests/src/Functional/Hal/BlockHalJsonAnonTest.php	@group hal
BlockHalJsonBasicAuthTest		class	Drupal\Tests\block\Functional\Hal	core/modules/block/tests/src/Functional/Hal/BlockHalJsonBasicAuthTest.php	@group hal
BlockHalJsonCookieTest		class	Drupal\Tests\block\Functional\Hal	core/modules/block/tests/src/Functional/Hal/BlockHalJsonCookieTest.php	@group hal
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 a newly installed theme does not inherit blocks to its hidden regions.
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	8
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 an active block assigned to a non-existing region triggers the warning message and is disabled.
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 if a block can be configured to be only visible on a particular language.
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

Other projects

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