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
BlockContentGetDependencyEvent		class	Drupal\block_content\Event	core/modules/block_content/src/Event/BlockContentGetDependencyEvent.php	Block content event to allow setting an access dependency.		2
BlockContentHalJsonAnonTest		class	Drupal\Tests\block_content\Functional\Hal	core/modules/block_content/tests/src/Functional/Hal/BlockContentHalJsonAnonTest.php	@group hal	2
BlockContentHalJsonBasicAuthTest		class	Drupal\Tests\block_content\Functional\Hal	core/modules/block_content/tests/src/Functional/Hal/BlockContentHalJsonBasicAuthTest.php	@group hal
BlockContentHalJsonCookieTest		class	Drupal\Tests\block_content\Functional\Hal	core/modules/block_content/tests/src/Functional/Hal/BlockContentHalJsonCookieTest.php	@group hal
BlockContentIntegrationTest		class	Drupal\Tests\block_content\Functional\Views	core/modules/block_content/tests/src/Functional/Views/BlockContentIntegrationTest.php	Tests the block_content integration into views.
BlockContentInterface		interface	Drupal\block_content	core/modules/block_content/src/BlockContentInterface.php	Provides an interface defining a custom block entity.	1	4
BlockContentJsonAnonTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentJsonAnonTest.php	@group rest
BlockContentJsonBasicAuthTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentJsonBasicAuthTest.php	@group rest
BlockContentJsonCookieTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentJsonCookieTest.php	@group rest
BlockContentListBuilder		class	Drupal\block_content	core/modules/block_content/src/BlockContentListBuilder.php	Defines a class to build a listing of custom block entities.
BlockContentListTest		class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/BlockContentListTest.php	Tests the listing of custom blocks.
BlockContentListViewsTest		class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/BlockContentListViewsTest.php	Tests the Views-powered listing of custom blocks.
BlockContentLocalTasksTest		class	Drupal\Tests\block_content\Unit\Menu	core/modules/block_content/tests/src/Unit/Menu/BlockContentLocalTasksTest.php	Tests existence of block_content local tasks.
BlockContentModerationHandler		class	Drupal\content_moderation\Entity\Handler	core/modules/content_moderation/src/Entity/Handler/BlockContentModerationHandler.php	Customizations for block content entities.		1
BlockContentPageViewTest		class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/BlockContentPageViewTest.php	Create a block and test block access by attempting to view the block.
BlockContentRedirectTest		class	Drupal\Tests\block_content\Functional\Views	core/modules/block_content/tests/src/Functional/Views/BlockContentRedirectTest.php	Tests the redirect destination on block content on entity operations.
BlockContentResourceTestBase		abstract class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentResourceTestBase.php	ResourceTestBase for BlockContent entity.	8	2
BlockContentResourceTestBase	in drupal:8.6.0 and is removed from drupal:9.0.0. Use Drupal\Tests\block_content\Functional\Rest\BlockContentResourceTestBase instead.	abstract class	Drupal\Tests\rest\Functional\EntityResource\BlockContent	core/modules/rest/tests/src/Functional/EntityResource/BlockContent/BlockContentResourceTestBase.php
BlockContentReusableUpdateTest		class	Drupal\Tests\block_content\Functional\Update	core/modules/block_content/tests/src/Functional/Update/BlockContentReusableUpdateTest.php	Tests 'reusable' field related update functions for the Block Content module.
BlockContentRevisionsTest		class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/BlockContentRevisionsTest.php	Create a block with revisions.
BlockContentSaveTest		class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/BlockContentSaveTest.php	Tests $block_content->save() for saving content.
BlockContentTest		class	Drupal\Tests\jsonapi\Functional	core/modules/jsonapi/tests/src/Functional/BlockContentTest.php	JSON:API integration test for the "BlockContent" content entity type.
BlockContentTestBase	in drupal:8.4.0 and is removed from drupal:9.0.0. Use \Drupal\Tests\block_content\Functional\Views\BlockContentTestBase.	abstract class	Drupal\block_content\Tests\Views	core/modules/block_content/src/Tests/Views/BlockContentTestBase.php	Base class for all block_content tests.
BlockContentTestBase	in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\block_content\Functional\BlockContentTestBase instead.	abstract class	Drupal\block_content\Tests	core/modules/block_content/src/Tests/BlockContentTestBase.php	Sets up block content types.
BlockContentTestBase		abstract class	Drupal\Tests\block_content\Functional\Views	core/modules/block_content/tests/src/Functional/Views/BlockContentTestBase.php	Base class for all block_content tests.	4
BlockContentTestBase		abstract class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/BlockContentTestBase.php	Sets up block content types.	11	1
BlockContentTranslationHandler		class	Drupal\block_content	core/modules/block_content/src/BlockContentTranslationHandler.php	Defines the translation handler for custom blocks.
BlockContentTranslationUITest		class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/BlockContentTranslationUITest.php	Tests the block content translation UI.
BlockContentType		class	Drupal\block_content\Entity	core/modules/block_content/src/Entity/BlockContentType.php	Defines the custom block type entity.		31
BlockContentTypeDeleteForm		class	Drupal\block_content\Form	core/modules/block_content/src/Form/BlockContentTypeDeleteForm.php	Provides a confirmation form for deleting a custom block type entity.
BlockContentTypeForm		class	Drupal\block_content	core/modules/block_content/src/BlockContentTypeForm.php	The block content type entity form.
BlockContentTypeHalJsonAnonTest		class	Drupal\Tests\block_content\Functional\Hal	core/modules/block_content/tests/src/Functional/Hal/BlockContentTypeHalJsonAnonTest.php	@group hal
BlockContentTypeHalJsonBasicAuthTest		class	Drupal\Tests\block_content\Functional\Hal	core/modules/block_content/tests/src/Functional/Hal/BlockContentTypeHalJsonBasicAuthTest.php	@group hal
BlockContentTypeHalJsonCookieTest		class	Drupal\Tests\block_content\Functional\Hal	core/modules/block_content/tests/src/Functional/Hal/BlockContentTypeHalJsonCookieTest.php	@group hal
BlockContentTypeInterface		interface	Drupal\block_content	core/modules/block_content/src/BlockContentTypeInterface.php	Provides an interface defining a custom block type entity.	1	3
BlockContentTypeJsonAnonTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentTypeJsonAnonTest.php	@group rest
BlockContentTypeJsonBasicAuthTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentTypeJsonBasicAuthTest.php	@group rest
BlockContentTypeJsonCookieTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentTypeJsonCookieTest.php	@group rest
BlockContentTypeListBuilder		class	Drupal\block_content	core/modules/block_content/src/BlockContentTypeListBuilder.php	Defines a class to build a listing of custom block type entities.
BlockContentTypeResourceTestBase		abstract class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentTypeResourceTestBase.php		10	4
BlockContentTypeResourceTestBase	in drupal:8.6.0 and is removed from drupal:9.0.0. Use Drupal\Tests\block_content\Functional\Rest\BlockContentTypeResourceTestBase instead.	abstract class	Drupal\Tests\rest\Functional\EntityResource\BlockContentType	core/modules/rest/tests/src/Functional/EntityResource/BlockContentType/BlockContentTypeResourceTestBase.php
BlockContentTypeTest		class	Drupal\Tests\jsonapi\Functional	core/modules/jsonapi/tests/src/Functional/BlockContentTypeTest.php	JSON:API integration test for the "BlockContentType" config entity type.
BlockContentTypeTest		class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/BlockContentTypeTest.php	Ensures that custom block type functions work correctly.
BlockContentTypeXmlAnonTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentTypeXmlAnonTest.php	@group rest
BlockContentTypeXmlBasicAuthTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentTypeXmlBasicAuthTest.php	@group rest
BlockContentTypeXmlCookieTest		class	Drupal\Tests\block_content\Functional\Rest	core/modules/block_content/tests/src/Functional/Rest/BlockContentTypeXmlCookieTest.php	@group rest
BlockContentUpdateTest		class	Drupal\Tests\block_content\Functional\Update	core/modules/block_content/tests/src/Functional/Update/BlockContentUpdateTest.php	Tests update functions for the Block Content module.
BlockContentUuidLookup		class	Drupal\block_content	core/modules/block_content/src/BlockContentUuidLookup.php	A cache collector that caches IDs for block_content UUIDs.		1	2
BlockContentValidationTest		class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/BlockContentValidationTest.php	Tests block content validation constraints.
BlockContentViewBuilder		class	Drupal\block_content	core/modules/block_content/src/BlockContentViewBuilder.php	View builder handler for custom blocks.

Other projects

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