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
BlockRepositoryTest		class	Drupal\Tests\block\Unit	core/modules/block/tests/src/Unit/BlockRepositoryTest.php	@coversDefaultClass \Drupal\block\BlockRepository[[api-linebreak]] @group block
BlockResourceTestBase		abstract class	Drupal\Tests\block\Functional\Rest	core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php		9	3
BlockResourceTestBase		abstract class	Drupal\Tests\block\Functional\Rest	core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php		9	3
BlockResourceTestBase		abstract class	Drupal\Tests\block\Functional\Rest	core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php		9	3
BlockResourceTestBase		abstract class	Drupal\Tests\block\Functional\Rest	core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php		9	3
BlockResourceTestBase		abstract class	Drupal\Tests\block\Functional\Rest	core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php		9	3
BlockResourceTestBase		abstract class	Drupal\Tests\block\Functional\Rest	core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php		9	3
BlockSettings		class	Drupal\block\Plugin\migrate\process	core/modules/block/src/Plugin/migrate/process/BlockSettings.php	Plugin annotation @MigrateProcessPlugin( id = "block_settings" )		1
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\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\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\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\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\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
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
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
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
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.
Book		class	Drupal\book\Plugin\migrate\source	core/modules/book/src/Plugin/migrate/source/Book.php	Drupal 6/7 book source from database.
Book		class	Drupal\book\Plugin\migrate\destination	core/modules/book/src/Plugin/migrate/destination/Book.php	Plugin annotation @MigrateDestination( id = "book", provider = "book" )
BookAdminEditForm		class	Drupal\book\Form	core/modules/book/src/Form/BookAdminEditForm.php	Provides a form for administering a single book's hierarchy.			1
BookAdminEditForm		class	Drupal\book\Form	core/modules/book/src/Form/BookAdminEditForm.php	Provides a form for administering a single book's hierarchy.			1
BookAdminEditForm		class	Drupal\book\Form	core/modules/book/src/Form/BookAdminEditForm.php	Provides a form for administering a single book's hierarchy.			1
BookBreadcrumbBuilder		class	Drupal\book	core/modules/book/src/BookBreadcrumbBuilder.php	Provides a breadcrumb builder for nodes in a book.			2
BookBreadcrumbBuilder		class	Drupal\book	core/modules/book/src/BookBreadcrumbBuilder.php	Provides a breadcrumb builder for nodes in a book.			2
BookBreadcrumbBuilder		class	Drupal\book	core/modules/book/src/BookBreadcrumbBuilder.php	Provides a breadcrumb builder for nodes in a book.			2
BookBreadcrumbTest		class	Drupal\Tests\book\Functional	core/modules/book/tests/src/Functional/BookBreadcrumbTest.php	Create a book, add pages, and test book interface.

Other projects

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