Classes, traits, and interfaces - 11.x - drupal

Primary tabs

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
Block class Drupal\views\Plugin\views\display core/modules/views/src/Plugin/views/display/Block.php The plugin that handles a block. 1
BlockAccessControlHandler class Drupal\block core/modules/block/src/BlockAccessControlHandler.php Defines the access control handler for the content block entity type. 1
BlockAddController class Drupal\block\Controller core/modules/block/src/Controller/BlockAddController.php Controller for building the block instance add form.
BlockAddTest class Drupal\Tests\block\FunctionalJavascript core/modules/block/tests/src/FunctionalJavascript/BlockAddTest.php Tests the JS functionality in the block add form.
BlockAdminThemeTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockAdminThemeTest.php Tests the block system with admin themes.
BlockBase abstract class Drupal\Core\Block core/lib/Drupal/Core/Block/BlockBase.php Defines a base block implementation that most blocks plugins will extend. 55 57
BlockBaseTest class Drupal\Tests\Core\Block core/tests/Drupal/Tests/Core/Block/BlockBaseTest.php Tests Drupal\Core\Block\BlockBase.
BlockBaseTest class Drupal\KernelTests\Core\Block core/tests/Drupal/KernelTests/Core/Block/BlockBaseTest.php Tests the BlockBase class, base for all block plugins.
BlockCacheTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockCacheTest.php Tests block caching.
BlockComponentRenderArray class Drupal\layout_builder\EventSubscriber core/modules/layout_builder/src/EventSubscriber/BlockComponentRenderArray.php Builds render arrays and handles access for all block components. 2 2
BlockComponentRenderArrayTest class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/BlockComponentRenderArrayTest.php Tests Drupal\layout_builder\EventSubscriber\BlockComponentRenderArray.
BlockConfigEntityUnitTest class Drupal\Tests\block\Unit core/modules/block/tests/src/Unit/BlockConfigEntityUnitTest.php Tests Drupal\block\Entity\Block.
BlockConfigSchemaTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockConfigSchemaTest.php Tests the block config schema.
BlockConfigSyncTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockConfigSyncTest.php Tests that blocks are not created during config sync.
BlockConfigUpdater class Drupal\block core/modules/block/src/BlockConfigUpdater.php Provides a BC layer for modules providing old configurations. 2
BlockContent class Drupal\block_content\Entity core/modules/block_content/src/Entity/BlockContent.php Defines the content block entity class. 35
BlockContent class Drupal\block_content\Plugin\views\wizard core/modules/block_content/src/Plugin/views/wizard/BlockContent.php Used for creating 'block_content' views with the wizard.
BlockContent class Drupal\block_content\Plugin\Derivative core/modules/block_content/src/Plugin/Derivative/BlockContent.php Retrieves block plugin definitions for all content blocks. 2
BlockContentAccessControlHandler class Drupal\block_content core/modules/block_content/src/BlockContentAccessControlHandler.php Defines the access control handler for the content block entity type. 2
BlockContentAccessHandlerTest class Drupal\Tests\block_content\Kernel core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php Tests the block content entity access handler.
BlockContentAddLocalAction class Drupal\block_content\Plugin\Menu\LocalAction core/modules/block_content/src/Plugin/Menu/LocalAction/BlockContentAddLocalAction.php Modifies the 'Add content block' local action. 1
BlockContentBlock class Drupal\block_content\Plugin\Block core/modules/block_content/src/Plugin/Block/BlockContentBlock.php Defines a generic block type.
BlockContentCacheTagsTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentCacheTagsTest.php Tests the Content Block entity's cache tags.
BlockContentContextualLinksTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentContextualLinksTest.php Tests views contextual links on block content.
BlockContentController class Drupal\block_content\Controller core/modules/block_content/src/Controller/BlockContentController.php Controller routines for custom block routes.
BlockContentCreationTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentCreationTest.php Create a block and test saving it.
BlockContentCreationTrait trait Drupal\Tests\block_content\Traits core/modules/block_content/tests/src/Traits/BlockContentCreationTrait.php Provides methods for creating block_content entities and types. 14
BlockContentDeleteForm class Drupal\block_content\Form core/modules/block_content/src/Form/BlockContentDeleteForm.php Provides a confirmation form for deleting a content block entity. 1
BlockContentDeletionTest class Drupal\Tests\block_content\Kernel core/modules/block_content/tests/src/Kernel/BlockContentDeletionTest.php Tests that deleting a block clears the cached definitions.
BlockContentDeriverTest class Drupal\Tests\block_content\Kernel core/modules/block_content/tests/src/Kernel/BlockContentDeriverTest.php Tests block content plugin deriver.
BlockContentEntityChangedConstraint class Drupal\block_content\Plugin\Validation\Constraint core/modules/block_content/src/Plugin/Validation/Constraint/BlockContentEntityChangedConstraint.php Validation constraint for the block content entity changed timestamp.
BlockContentEntityChangedConstraintValidator class Drupal\block_content\Plugin\Validation\Constraint core/modules/block_content/src/Plugin/Validation/Constraint/BlockContentEntityChangedConstraintValidator.php Validates the BlockContentEntityChanged constraint.
BlockContentEntityReferenceSelectionTest class Drupal\Tests\block_content\Kernel core/modules/block_content/tests/src/Kernel/BlockContentEntityReferenceSelectionTest.php Tests EntityReference selection handlers don't return non-reusable blocks.
BlockContentEvents final class Drupal\block_content core/modules/block_content/src/BlockContentEvents.php Defines events for the block_content module. 1
BlockContentFieldFilterTest class Drupal\Tests\block_content\Functional\Views core/modules/block_content/tests/src/Functional/Views/BlockContentFieldFilterTest.php Tests block_content field filters with translations.
BlockContentForm class Drupal\block_content core/modules/block_content/src/BlockContentForm.php Form handler for the content block edit forms. 1
BlockContentGetDependencyEvent class Drupal\block_content\Event core/modules/block_content/src/Event/BlockContentGetDependencyEvent.php Block content event to allow setting an access dependency. 2
BlockContentHooks class Drupal\block_content\Hook core/modules/block_content/src/Hook/BlockContentHooks.php Hook implementations for block_content. 2
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 content block entity. 1 10
BlockContentIsReusableAccessCheck class Drupal\block_content\Access core/modules/block_content/src/Access/BlockContentIsReusableAccessCheck.php Provides an access check for non-reusable block content entities. 2
BlockContentJsonAnonTest class Drupal\Tests\block_content\Functional\Rest core/modules/block_content/tests/src/Functional/Rest/BlockContentJsonAnonTest.php Tests Block Content Json Anon.
BlockContentJsonBasicAuthTest class Drupal\Tests\block_content\Functional\Rest core/modules/block_content/tests/src/Functional/Rest/BlockContentJsonBasicAuthTest.php Tests Block Content Json Basic Auth.
BlockContentJsonCookieTest class Drupal\Tests\block_content\Functional\Rest core/modules/block_content/tests/src/Functional/Rest/BlockContentJsonCookieTest.php Tests Block Content Json Cookie.
BlockContentListBuilder class Drupal\block_content core/modules/block_content/src/BlockContentListBuilder.php Defines a class to build a listing of content block entities. 1
BlockContentListTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentListTest.php Tests the listing of content blocks.
BlockContentListViewsTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentListViewsTest.php Tests the Views-powered listing of content 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.

Other projects


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