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
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
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_block() function.
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\views\Unit\Plugin\views\display	core/modules/views/tests/src/Unit/Plugin/views/display/BlockTest.php	@coversDefaultClass \Drupal\views\Plugin\views\display\Block[[api-linebreak]] @group block
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
BlockTheme		class	Drupal\block\Plugin\migrate\process	core/modules/block/src/Plugin/migrate/process/BlockTheme.php	Plugin annotation @MigrateProcessPlugin( id = "block_theme" )
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.
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.
BlockViewBuilder		class	Drupal\block	core/modules/block/src/BlockViewBuilder.php	Provides a Block view builder.
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	Plugin annotation @MigrateProcessPlugin( id = "block_visibility" )		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.
BlockXmlAnonTest		class	Drupal\Tests\block\Functional\Rest	core/modules/block/tests/src/Functional/Rest/BlockXmlAnonTest.php	@group rest
BlockXmlBasicAuthTest		class	Drupal\Tests\block\Functional\Rest	core/modules/block/tests/src/Functional/Rest/BlockXmlBasicAuthTest.php	@group rest
BlockXmlCookieTest		class	Drupal\Tests\block\Functional\Rest	core/modules/block/tests/src/Functional/Rest/BlockXmlCookieTest.php	@group rest
BlockXssTest		class	Drupal\Tests\block\Functional	core/modules/block/tests/src/Functional/BlockXssTest.php	Tests that the block module properly escapes block descriptions.
BookManagerDeprecationTest		class	Drupal\Tests\book\Kernel	core/modules/book/tests/src/Kernel/BookManagerDeprecationTest.php	@coversDefaultClass \Drupal\book\BookManager[[api-linebreak]] @group legacy
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
BooleanFormatter		class	Drupal\Core\Field\Plugin\Field\FieldFormatter	core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php	Plugin implementation of 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
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.
BootstrapConfigStorageFactory		class	Drupal\Core\Config	core/lib/Drupal/Core/Config/BootstrapConfigStorageFactory.php	Defines a factory for retrieving the config storage used pre-kernel.		2
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 custom 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 custom 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.		12
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.	7	7
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	@coversDefaultClass \Drupal\Core\Breadcrumb\BreadcrumbManager[[api-linebreak]] @group Breadcrumb
BreadcrumbTest		class	Drupal\Tests\Core\Breadcrumb	core/tests/Drupal/Tests/Core/Breadcrumb/BreadcrumbTest.php	@coversDefaultClass \Drupal\Core\Breadcrumb\Breadcrumb[[api-linebreak]] @group Breadcrumb
BreadcrumbTest		class	Drupal\Tests\system\Functional\Menu	core/modules/system/tests/src/Functional/Menu/BreadcrumbTest.php	Tests breadcrumbs functionality.
BreakLockForm		class	Drupal\views_ui\Form	core/modules/views_ui/src/Form/BreakLockForm.php	Builds the form to break the lock of an edited view.
BreakLockLink		class	Drupal\Core\TempStore\Element	core/lib/Drupal/Core/TempStore/Element/BreakLockLink.php	Provides a link to break a tempstore lock.

Other projects

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