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 1519

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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.
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.
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. 2
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
BooleanItemNormalizer class Drupal\test_fieldtype_boolean_emoji_normalizer\Normalizer core/modules/serialization/tests/modules/test_fieldtype_boolean_emoji_normalizer/src/Normalizer/BooleanItemNormalizer.php Normalizes boolean fields weirdly: renders them as 👍 (TRUE) or 👎 (FALSE). 2
BooleanItemTest class Drupal\Tests\field\Kernel\Boolean core/modules/field/tests/src/Kernel/Boolean/BooleanItemTest.php Tests the new entity API for the boolean field type.
BooleanNormalizer class Drupal\test_datatype_boolean_emoji_normalizer\Normalizer core/modules/serialization/tests/modules/test_datatype_boolean_emoji_normalizer/src/Normalizer/BooleanNormalizer.php Normalizes boolean data weirdly: renders them as 👍 (TRUE) or 👎 (FALSE). 2
BooleanOperator class Drupal\views\Plugin\views\filter core/modules/views/src/Plugin/views/filter/BooleanOperator.php Simple filter to handle matching of boolean values. 3 2
BooleanOperatorString class Drupal\views\Plugin\views\filter core/modules/views/src/Plugin/views/filter/BooleanOperatorString.php Simple filter to handle matching of boolean values.
BootableCommandTrait trait Drupal\Core\Command core/lib/Drupal/Core/Command/BootableCommandTrait.php Contains helper methods for console commands that boot up Drupal. 3
BootstrapConfigStorageFactory class Drupal\Core\Config core/lib/Drupal/Core/Config/BootstrapConfigStorageFactory.php Defines a factory for retrieving the config storage used pre-kernel. 2
BootstrapErrorHandler final class Drupal\TestTools\ErrorHandler core/tests/Drupal/TestTools/ErrorHandler/BootstrapErrorHandler.php Drupal's PHPUnit base error handler. 1
Box class Drupal\block_content\Plugin\migrate\source\d6 core/modules/block_content/src/Plugin/migrate/source/d6/Box.php Drupal 6 block source from database.
BoxTest class Drupal\Tests\block_content\Kernel\Plugin\migrate\source\d6 core/modules/block_content/tests/src/Kernel/Plugin/migrate/source/d6/BoxTest.php Tests D6 block boxes source plugin.
BoxTranslation class Drupal\block_content\Plugin\migrate\source\d6 core/modules/block_content/src/Plugin/migrate/source/d6/BoxTranslation.php Drupal 6 i18n content block translations source from database.
BoxTranslationTest class Drupal\Tests\block_content\Kernel\Plugin\migrate\source\d6 core/modules/block_content/tests/src/Kernel/Plugin/migrate/source/d6/BoxTranslationTest.php Tests i18n content block translations source plugin.
Breadcrumb class Drupal\Core\Breadcrumb core/lib/Drupal/Core/Breadcrumb/Breadcrumb.php Used to return generated breadcrumbs with associated cacheability metadata. 11
Breadcrumb404Test class Drupal\FunctionalTests\Breadcrumb core/tests/Drupal/FunctionalTests/Breadcrumb/Breadcrumb404Test.php Tests the breadcrumb of 404 pages.
BreadcrumbBuilderInterface interface Drupal\Core\Breadcrumb core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php Defines an interface for classes that build breadcrumbs. 6 6
BreadcrumbFrontCacheContextsTest class Drupal\Tests\system\Functional\Menu core/modules/system/tests/src/Functional/Menu/BreadcrumbFrontCacheContextsTest.php Tests breadcrumbs functionality.
BreadcrumbManager class Drupal\Core\Breadcrumb core/lib/Drupal/Core/Breadcrumb/BreadcrumbManager.php Provides a breadcrumb manager. 1 2
BreadcrumbManagerTest class Drupal\Tests\Core\Breadcrumb core/tests/Drupal/Tests/Core/Breadcrumb/BreadcrumbManagerTest.php Tests Drupal\Core\Breadcrumb\BreadcrumbManager.

Other projects

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