Classes, traits, and interfaces - 10.3.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 1518

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
BlankLayout class Drupal\layout_builder\Plugin\Layout core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php Provides a layout plugin that produces no output.
Block class Drupal\views\Plugin\views\display core/modules/views/src/Plugin/views/display/Block.php The plugin that handles a block.
Block class Drupal\Core\Block\Attribute core/lib/Drupal/Core/Block/Attribute/Block.php The Block attribute. 54
Block class Drupal\Core\Block\Annotation core/lib/Drupal/Core/Block/Annotation/Block.php Defines a Block annotation object.
Block class Drupal\block\Entity core/modules/block/src/Entity/Block.php Defines a Block configuration entity class. 46
Block class Drupal\block\Plugin\migrate\source core/modules/block/src/Plugin/migrate/source/Block.php Drupal 6/7 block source from database. 2 2
BlockAccessControlHandler class Drupal\block core/modules/block/src/BlockAccessControlHandler.php Defines the access control handler for the content block entity type.
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. 51 52
BlockBaseTest class Drupal\Tests\Core\Block core/tests/Drupal/Tests/Core/Block/BlockBaseTest.php @coversDefaultClass \Drupal\Core\Block\BlockBase @group block
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 @coversDefaultClass \Drupal\layout_builder\EventSubscriber\BlockComponentRenderArray @group layout_builder
BlockConfigEntityUnitTest class Drupal\Tests\block\Unit core/modules/block/tests/src/Unit/BlockConfigEntityUnitTest.php @coversDefaultClass \Drupal\block\Entity\Block @group block
BlockConfigSchemaTest class Drupal\Tests\block\Kernel core/modules/block/tests/src/Kernel/BlockConfigSchemaTest.php Tests the block config schema.
BlockConfigSchemaTest class Drupal\Tests\book\Kernel\Block core/modules/book/tests/src/Kernel/Block/BlockConfigSchemaTest.php Tests the block config schema.
BlockContent class Drupal\block_content\Entity core/modules/block_content/src/Entity/BlockContent.php Defines the content block entity class. 38
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. 1
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
BlockContentCreationTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentCreationTest.php Create a block and test saving it.
BlockContentDeleteForm class Drupal\block_content\Form core/modules/block_content/src/Form/BlockContentDeleteForm.php Provides a confirmation form for deleting a content block entity.
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.
BlockContentGetDependencyEvent class Drupal\block_content\Event core/modules/block_content/src/Event/BlockContentGetDependencyEvent.php Block content event to allow setting an access dependency. 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 9
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 content block entities.
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.