Classes, traits, and interfaces - main - 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 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
LatestRevision class Drupal\views\Plugin\views\filter core/modules/views/src/Plugin/views/filter/LatestRevision.php Filter to show only the latest revision of an entity.
LatestRevisionCheck class Drupal\content_moderation\Access core/modules/content_moderation/src/Access/LatestRevisionCheck.php Access check for the entity moderation tab. 2 2
LatestRevisionCheckTest class Drupal\Tests\content_moderation\Unit core/modules/content_moderation/tests/src/Unit/LatestRevisionCheckTest.php Tests Drupal\content_moderation\Access\LatestRevisionCheck.
LatestRevisionFilterTest class Drupal\Tests\views\Kernel\Entity core/modules/views/tests/src/Kernel/Entity/LatestRevisionFilterTest.php Tests the 'Latest revision' filter.
LatestTranslationAffectedRevision class Drupal\views\Plugin\views\filter core/modules/views/src/Plugin/views/filter/LatestTranslationAffectedRevision.php Filter to show only the latest translation affected revision of an entity.
LatestTranslationAffectedRevisionTest class Drupal\Tests\views\Kernel\Entity core/modules/views/tests/src/Kernel/Entity/LatestTranslationAffectedRevisionTest.php Tests the 'Latest translation affected revision' filter.
Layout class Drupal\Core\Layout\Attribute core/lib/Drupal/Core/Layout/Attribute/Layout.php Defines a Layout attribute object. 8
Layout class Drupal\Core\Layout\Annotation core/lib/Drupal/Core/Layout/Annotation/Layout.php Defines a Layout annotation object.
LayoutAttributeTest class Drupal\Tests\Core\Layout core/tests/Drupal/Tests/Core/Layout/LayoutAttributeTest.php Tests the Layout attribute.
LayoutBuilder class Drupal\layout_builder\Element core/modules/layout_builder/src/Element/LayoutBuilder.php Defines a render element for building the Layout Builder UI.
LayoutBuilderAccessCheck class Drupal\layout_builder\Access core/modules/layout_builder/src/Access/LayoutBuilderAccessCheck.php Provides an access check for the Layout Builder defaults. 2
LayoutBuilderAccessTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderAccessTest.php Tests access to Layout Builder.
LayoutBuilderBlockContentDependencyTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/LayoutBuilderBlockContentDependencyTest.php Test for installing Layout Builder before Block Content in the same request.
LayoutBuilderBlockContentDependencyTestThemeHooks class Drupal\layout_builder_block_content_dependency_test\Hook core/modules/layout_builder/tests/modules/layout_builder_block_content_dependency_test/src/Hook/LayoutBuilderBlockContentDependencyTestThemeHooks.php Hook implementations for layout_builder_block_content_dependency_test.
LayoutBuilderBlocksTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderBlocksTest.php Tests the Layout Builder UI with blocks.
LayoutBuilderBreadcrumbAlterTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/LayoutBuilderBreadcrumbAlterTest.php Tests layout_builder_system_breadcrumb_alter().
LayoutBuilderCompatibilityTestBase abstract class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/LayoutBuilderCompatibilityTestBase.php Tests Layout Builder's compatibility with existing systems. 2
LayoutBuilderContentModerationIntegrationTest class Drupal\Tests\content_moderation\Functional core/modules/content_moderation/tests/src/Functional/LayoutBuilderContentModerationIntegrationTest.php Tests Content Moderation's integration with Layout Builder.
LayoutBuilderContextTrait trait Drupal\layout_builder\Context core/modules/layout_builder/src/Context/LayoutBuilderContextTrait.php Provides a wrapper around getting contexts from a section storage object. 6
LayoutBuilderController class Drupal\layout_builder\Controller core/modules/layout_builder/src/Controller/LayoutBuilderController.php Defines a controller to provide the Layout Builder admin UI.
LayoutBuilderDefaultValuesTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderDefaultValuesTest.php Tests rendering default field values in Layout Builder.
LayoutBuilderDisableForm class Drupal\layout_builder\Form core/modules/layout_builder/src/Form/LayoutBuilderDisableForm.php Disables Layout Builder for a given default.
LayoutBuilderDisableInteractionsTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderDisableInteractionsTest.php Tests the Layout Builder disables interactions of rendered blocks.
LayoutBuilderEnabledInterface interface Drupal\layout_builder core/modules/layout_builder/src/LayoutBuilderEnabledInterface.php Provides methods for enabling and disabling Layout Builder. 2 2
LayoutBuilderEntityFormTrait trait Drupal\layout_builder\Form core/modules/layout_builder/src/Form/LayoutBuilderEntityFormTrait.php Provides a trait for common methods used in Layout Builder entity forms. 1
LayoutBuilderEntityViewDisplay class Drupal\layout_builder\Entity core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php Provides an entity view display entity that has a layout. 2 44
LayoutBuilderEntityViewDisplay class Drupal\layout_builder_override_dependency core/modules/layout_builder/tests/modules/layout_builder_override_dependency/src/LayoutBuilderEntityViewDisplay.php Provides an entity view display entity that has a layout. 2
LayoutBuilderEntityViewDisplay class Drupal\layout_builder_override core/modules/layout_builder/tests/modules/layout_builder_override/src/LayoutBuilderEntityViewDisplay.php Provides an entity view display entity that has a layout. 2
LayoutBuilderEntityViewDisplayForm class Drupal\layout_builder\Form core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php Edit form for the LayoutBuilderEntityViewDisplay entity type. 1
LayoutBuilderEntityViewDisplayJsonAnonTest class Drupal\Tests\layout_builder\Functional\Rest core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayJsonAnonTest.php Tests Layout Builder Entity View Display Json Anon.
LayoutBuilderEntityViewDisplayJsonBasicAuthTest class Drupal\Tests\layout_builder\Functional\Rest core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayJsonBasicAuthTest.php Tests Layout Builder Entity View Display Json Basic Auth.
LayoutBuilderEntityViewDisplayJsonCookieTest class Drupal\Tests\layout_builder\Functional\Rest core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayJsonCookieTest.php Tests Layout Builder Entity View Display Json Cookie.
LayoutBuilderEntityViewDisplayResourceTestBase abstract class Drupal\Tests\layout_builder\Functional\Rest core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayResourceTestBase.php Provides a base class for testing LayoutBuilderEntityViewDisplay resources. 6
LayoutBuilderEntityViewDisplayStorage class Drupal\layout_builder\Entity core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplayStorage.php Provides storage for entity view display entities that have layouts. 1
LayoutBuilderEntityViewDisplayTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayTest.php Tests Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay.
LayoutBuilderEntityViewDisplayTest class Drupal\Tests\layout_builder\Functional\Jsonapi core/modules/layout_builder/tests/src/Functional/Jsonapi/LayoutBuilderEntityViewDisplayTest.php JSON:API integration test for the "EntityViewDisplay" config entity type.
LayoutBuilderEntityViewDisplayValidationTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/LayoutBuilderEntityViewDisplayValidationTest.php Tests validation of Layout Builder's entity_view_display entities.
LayoutBuilderEntityViewDisplayXmlAnonTest class Drupal\Tests\layout_builder\Functional\Rest core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayXmlAnonTest.php Tests Layout Builder Entity View Display Xml Anon.
LayoutBuilderEntityViewDisplayXmlBasicAuthTest class Drupal\Tests\layout_builder\Functional\Rest core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayXmlBasicAuthTest.php Tests Layout Builder Entity View Display Xml Basic Auth.
LayoutBuilderEntityViewDisplayXmlCookieTest class Drupal\Tests\layout_builder\Functional\Rest core/modules/layout_builder/tests/src/Functional/Rest/LayoutBuilderEntityViewDisplayXmlCookieTest.php Tests Layout Builder Entity View Display Xml Cookie.
LayoutBuilderEvents final class Drupal\layout_builder core/modules/layout_builder/src/LayoutBuilderEvents.php Defines events for the layout_builder module. 5
LayoutBuilderExposeAllFieldBlocksHooks class Drupal\layout_builder_expose_all_field_blocks\Hook core/modules/layout_builder/modules/layout_builder_expose_all_field_blocks/src/Hook/LayoutBuilderExposeAllFieldBlocksHooks.php Hook implementations for layout_builder_expose_all_field_blocks.
LayoutBuilderExtraFieldTestHooks class Drupal\layout_builder_extra_field_test\Hook core/modules/layout_builder/tests/modules/layout_builder_extra_field_test/src/Hook/LayoutBuilderExtraFieldTestHooks.php Hook implementations for layout_builder_extra_field_test.
LayoutBuilderFieldBlockEntityReferenceCacheTagsTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderFieldBlockEntityReferenceCacheTagsTest.php Tests cache tags on entity reference field blocks in Layout Builder.
LayoutBuilderFormBlockTestHooks class Drupal\layout_builder_form_block_test\Hook core/modules/layout_builder/tests/modules/layout_builder_form_block_test/src/Hook/LayoutBuilderFormBlockTestHooks.php Hooks for layout_builder_form_block_test.
LayoutBuilderFormModeTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderFormModeTest.php Tests Layout Builder forms.
LayoutBuilderHighlightTrait trait Drupal\layout_builder core/modules/layout_builder/src/LayoutBuilderHighlightTrait.php A trait for generating IDs used to highlight active UI elements. 8
LayoutBuilderHooks class Drupal\layout_builder\Hook core/modules/layout_builder/src/Hook/LayoutBuilderHooks.php Hook implementations for layout_builder. 3
LayoutBuilderInstallTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/LayoutBuilderInstallTest.php Ensures that Layout Builder and core EntityViewDisplays are compatible.
LayoutBuilderIsActiveCacheContext class Drupal\layout_builder\Cache core/modules/layout_builder/src/Cache/LayoutBuilderIsActiveCacheContext.php Determines whether Layout Builder is active for a given entity type or not. 1 2

Other projects

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