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 1531

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
BlockRegion class Drupal\block\Plugin\migrate\process core/modules/block/src/Plugin/migrate/process/BlockRegion.php Determines the region for a block. 1
BlockRegionTest class Drupal\Tests\block\Unit\Plugin\migrate\process core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockRegionTest.php Tests Drupal\block\Plugin\migrate\process\BlockRegion.
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. 2 2
BlockRepositoryInterface interface Drupal\block core/modules/block/src/BlockRepositoryInterface.php Provides an interface for the block repository. 1 1
BlockRepositoryTest class Drupal\Tests\block\Unit core/modules/block/tests/src/Unit/BlockRepositoryTest.php Tests Drupal\block\BlockRepository.
BlockResourceTestBase abstract class Drupal\Tests\block\Functional\Rest core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php Resource test base for the block entity. 6
BlockSettings class Drupal\block\Plugin\migrate\process core/modules/block/src/Plugin/migrate/process/BlockSettings.php Determines the block settings. 1
BlockSettingsTest class Drupal\Tests\block\Unit\Plugin\migrate\process core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockSettingsTest.php Tests Drupal\block\Plugin\migrate\process\BlockSettings.
BlockStorageUnitTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockStorageUnitTest.php Tests the storage of blocks.
BlockSystemBrandingTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockSystemBrandingTest.php Tests branding block display.
BlockTemplateSuggestionsTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockTemplateSuggestionsTest.php Tests the block theme suggestions.
BlockTemplateSuggestionsTest class Drupal\Tests\block_content\Kernel core/modules/block_content/tests/src/Kernel/BlockTemplateSuggestionsTest.php Tests the block_content_theme_suggestions_block() function.
BlockTest class Drupal\Tests\views\Unit\Plugin\views\display core/modules/views/tests/src/Unit/Plugin/views/display/BlockTest.php Tests Drupal\views\Plugin\views\display\Block.
BlockTest class Drupal\Tests\block\Kernel\Plugin\migrate\source core/modules/block/tests/src/Kernel/Plugin/migrate/source/BlockTest.php Tests block source plugin. 1 1
BlockTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockTest.php Tests basic block functionality.
BlockTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/BlockTest.php JSON:API integration test for the "Block" config entity type.
BlockTestBase abstract class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockTestBase.php Provides setup and helper methods for block module tests. 2
BlockTestHooks class Drupal\block_test\Hook core/modules/block/tests/modules/block_test/src/Hook/BlockTestHooks.php Hook implementations for block_test.
BlockTheme class Drupal\block\Plugin\migrate\process core/modules/block/src/Plugin/migrate/process/BlockTheme.php Determines the theme to use for a block.
BlockThemeHooks class Drupal\block\Hook core/modules/block/src/Hook/BlockThemeHooks.php Hook implementations for block.
BlockTranslation class Drupal\block\Plugin\migrate\source\d6 core/modules/block/src/Plugin/migrate/source/d6/BlockTranslation.php Drupal 6 i18n block data from database. 1
BlockTranslation class Drupal\block\Plugin\migrate\source\d7 core/modules/block/src/Plugin/migrate/source/d7/BlockTranslation.php Drupal 7 i18n block data from database. 1
BlockTranslationTest class Drupal\Tests\block\Kernel\Plugin\migrate\source\d6 core/modules/block/tests/src/Kernel/Plugin/migrate/source/d6/BlockTranslationTest.php Tests i18n block source plugin.
BlockTranslationTest class Drupal\Tests\block\Kernel\Plugin\migrate\source\d7 core/modules/block/tests/src/Kernel/Plugin/migrate/source/d7/BlockTranslationTest.php Tests i18n block source plugin.
BlockTypeAccessControlHandler class Drupal\block_content core/modules/block_content/src/BlockTypeAccessControlHandler.php Defines the access control handler for the "Block Type" entity type. 1
BlockUiTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockUiTest.php Tests that the block configuration UI exists and stores data correctly.
BlockUser class Drupal\user\Plugin\Action core/modules/user/src/Plugin/Action/BlockUser.php Blocks a user.
BlockValidationTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockValidationTest.php Tests validation of block entities.
BlockViewBuilder class Drupal\block core/modules/block/src/BlockViewBuilder.php Provides a Block view builder. 1
BlockViewBuilderTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockViewBuilderTest.php Tests the block view builder.
BlockVisibility class Drupal\block\Plugin\migrate\process core/modules/block/src/Plugin/migrate/process/BlockVisibility.php Determines the visibility for a block. 1
BlockVisibilityTest class Drupal\Tests\block\Unit\Plugin\migrate\process core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockVisibilityTest.php Tests the block_visibility process plugin.
BlockWeightUpdateTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockWeightUpdateTest.php Tests Block Weight Update.
BlockXmlAnonTest class Drupal\Tests\block\Functional\Rest core/modules/block/tests/src/Functional/Rest/BlockXmlAnonTest.php Tests Block Xml Anon.
BlockXmlBasicAuthTest class Drupal\Tests\block\Functional\Rest core/modules/block/tests/src/Functional/Rest/BlockXmlBasicAuthTest.php Tests Block Xml Basic Auth.
BlockXmlCookieTest class Drupal\Tests\block\Functional\Rest core/modules/block/tests/src/Functional/Rest/BlockXmlCookieTest.php Tests Block Xml Cookie.
BlockXssTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockXssTest.php Tests that the block module properly escapes block descriptions.
BodyFieldCreationTrait trait Drupal\Tests\field\Traits core/modules/field/tests/src/Traits/BodyFieldCreationTrait.php Provides a method to create a body field for a given bundle. 3
Boolean class Drupal\views\Plugin\views\field core/modules/views/src/Plugin/views/field/Boolean.php A handler to provide proper displays for booleans.
BooleanCheckboxWidget class Drupal\Core\Field\Plugin\Field\FieldWidget core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php Plugin implementation of the 'boolean_checkbox' widget.
BooleanData class Drupal\Core\TypedData\Plugin\DataType core/lib/Drupal/Core/TypedData/Plugin/DataType/BooleanData.php The boolean data type. 4 1
BooleanFieldTest class Drupal\Tests\field\Functional\Boolean core/modules/field/tests/src/Functional/Boolean/BooleanFieldTest.php Tests boolean field functionality.
BooleanFormatter class Drupal\Core\Field\Plugin\Field\FieldFormatter core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php Plugin implementation of the 'boolean' formatter.
BooleanFormatterSettingsTest class Drupal\Tests\field\Functional\Boolean core/modules/field/tests/src/Functional/Boolean/BooleanFormatterSettingsTest.php Tests the Boolean field formatter settings.
BooleanFormatterSettingsTest class Drupal\Tests\field\FunctionalJavascript\Boolean core/modules/field/tests/src/FunctionalJavascript/Boolean/BooleanFormatterSettingsTest.php Tests the Boolean field formatter settings.
BooleanFormatterTest class Drupal\Tests\field\Kernel\Boolean core/modules/field/tests/src/Kernel/Boolean/BooleanFormatterTest.php Tests the boolean formatter.
BooleanInterface interface Drupal\Core\TypedData\Type core/lib/Drupal/Core/TypedData/Type/BooleanInterface.php Interface for boolean data. 1 4
BooleanItem class Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/BooleanItem.php Defines the 'boolean' entity field type. 1 6

Other projects

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