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
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. 7 1
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 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\hal\Functional\block_content core/modules/hal/tests/src/Functional/block_content/BlockContentTypeHalJsonAnonTest.php @group hal @group legacy
BlockContentTypeHalJsonBasicAuthTest class Drupal\Tests\hal\Functional\block_content core/modules/hal/tests/src/Functional/block_content/BlockContentTypeHalJsonBasicAuthTest.php @group hal @group legacy
BlockContentTypeHalJsonCookieTest class Drupal\Tests\hal\Functional\block_content core/modules/hal/tests/src/Functional/block_content/BlockContentTypeHalJsonCookieTest.php @group hal @group legacy
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 9 3
BlockContentTypeTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/BlockContentTypeTest.php Ensures that custom block type functions work correctly.
BlockContentTypeTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/BlockContentTypeTest.php JSON:API integration test for the "BlockContentType" config entity type.
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
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.
BlockContentViewsData class Drupal\block_content core/modules/block_content/src/BlockContentViewsData.php Provides the views data for the block_content entity type.
BlockContentWizardTest class Drupal\Tests\block_content\Functional\Views core/modules/block_content/tests/src/Functional/Views/BlockContentWizardTest.php Tests block_content wizard and generic entity integration.
BlockContentXmlAnonTest class Drupal\Tests\block_content\Functional\Rest core/modules/block_content/tests/src/Functional/Rest/BlockContentXmlAnonTest.php @group rest
BlockContentXmlBasicAuthTest class Drupal\Tests\block_content\Functional\Rest core/modules/block_content/tests/src/Functional/Rest/BlockContentXmlBasicAuthTest.php @group rest
BlockContentXmlCookieTest class Drupal\Tests\block_content\Functional\Rest core/modules/block_content/tests/src/Functional/Rest/BlockContentXmlCookieTest.php @group rest
BlockContextualLinksTest class Drupal\Tests\block\FunctionalJavascript core/modules/block/tests/src/FunctionalJavascript/BlockContextualLinksTest.php Tests the contextual links added while rendering the block.
BlockController class Drupal\block\Controller core/modules/block/src/Controller/BlockController.php Controller routines for admin block routes.
BlockCreationTrait trait Drupal\Tests\block\Traits core/modules/block/tests/src/Traits/BlockCreationTrait.php Provides methods to create and place block with default settings. 10
BlockCustom class Drupal\block_content\Plugin\migrate\source\d7 core/modules/block_content/src/Plugin/migrate/source/d7/BlockCustom.php Drupal 7 custom block source from database.
BlockCustomTest class Drupal\Tests\block_content\Kernel\Plugin\migrate\source\d7 core/modules/block_content/tests/src/Kernel/Plugin/migrate/source/d7/BlockCustomTest.php Tests d7_block_custom source plugin.
BlockCustomTranslation class Drupal\block_content\Plugin\migrate\source\d7 core/modules/block_content/src/Plugin/migrate/source/d7/BlockCustomTranslation.php Drupal 7 i18n custom block translations source from database. 1 1
BlockCustomTranslationTest class Drupal\Tests\block_content\Kernel\Plugin\migrate\source\d7 core/modules/block_content/tests/src/Kernel/Plugin/migrate/source/d7/BlockCustomTranslationTest.php Tests i18n custom block translations source plugin.
BlockDeleteForm class Drupal\block\Form core/modules/block/src/Form/BlockDeleteForm.php Provides a deletion confirmation form for the block instance deletion form.
BlockDemoTest class Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/BlockDemoTest.php Tests the block demo page with admin themes.
BlockDependenciesTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/BlockDependenciesTest.php Tests views block config dependencies functionality.
BlockedIp class Drupal\ban\Plugin\migrate\destination core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php Destination for blocked IP addresses. 1
BlockedIps class Drupal\ban\Plugin\migrate\source\d7 core/modules/ban/src/Plugin/migrate/source/d7/BlockedIps.php Drupal 7 blocked IPs source from database.
BlockedIpsTest class Drupal\Tests\ban\Kernel\Plugin\migrate\source\d7 core/modules/ban/tests/src/Kernel/Plugin/migrate/source/d7/BlockedIpsTest.php Tests D7 blocked_ip source plugin.
BlockEntitySettingTrayForm class Drupal\settings_tray\Block core/modules/settings_tray/src/Block/BlockEntitySettingTrayForm.php Provides form for block instance forms when used in the off-canvas dialog. 1
BlockExposedFilterAJAXTest class Drupal\Tests\views\FunctionalJavascript core/modules/views/tests/src/FunctionalJavascript/BlockExposedFilterAJAXTest.php Tests the exposed filter ajax functionality in a block.
BlockFilterTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/BlockFilterTest.php Tests the JavaScript functionality of the block add filter.

Other projects

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