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
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
LayoutBuilderIsActiveCacheContextTest class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/LayoutBuilderIsActiveCacheContextTest.php Tests Drupal\layout_builder\Cache\LayoutBuilderIsActiveCacheContext.
LayoutBuilderLocalTaskDeriver class Drupal\layout_builder\Plugin\Derivative core/modules/layout_builder/src/Plugin/Derivative/LayoutBuilderLocalTaskDeriver.php Provides local task definitions for the layout builder user interface. 1
LayoutBuilderLocalTaskTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderLocalTaskTest.php Tests Layout Builder local tasks.
LayoutBuilderNestedFormUiTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderNestedFormUiTest.php Tests placing blocks containing forms in theLayout Builder UI.
LayoutBuilderOptInTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderOptInTest.php Tests the ability for opting in and out of Layout Builder.
LayoutBuilderOverridableInterface interface Drupal\layout_builder core/modules/layout_builder/src/LayoutBuilderOverridableInterface.php Provides an interface for displays that could be overridable. 2 1
LayoutBuilderOverrideHook class Drupal\layout_builder_override_dependency\Hook core/modules/layout_builder/tests/modules/layout_builder_override_dependency/src/Hook/LayoutBuilderOverrideHook.php Hook implementations for layout_builder_override_dependency.
LayoutBuilderOverrideHook class Drupal\layout_builder_override\Hook core/modules/layout_builder/tests/modules/layout_builder_override/src/Hook/LayoutBuilderOverrideHook.php Hook implementations for layout_builder_override.
LayoutBuilderOverridesEditingThemeTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderOverridesEditingThemeTest.php Tests overrides editing uses the correct theme.
LayoutBuilderOverridesPermissions class Drupal\layout_builder core/modules/layout_builder/src/LayoutBuilderOverridesPermissions.php Provides dynamic permissions for Layout Builder overrides.
LayoutBuilderOverridesTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderOverridesTest.php Tests the Layout Builder UI.
LayoutBuilderOverrideTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/LayoutBuilderOverrideTest.php Test entity view display override on top of Layout Builder override.
LayoutBuilderPrepareLayoutTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderPrepareLayoutTest.php Tests the ability to alter a layout builder element while preparing.
LayoutBuilderRevisionTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderRevisionTest.php Tests that entity revisions work with Layout Builder.
LayoutBuilderRoutes class Drupal\layout_builder\Routing core/modules/layout_builder/src/Routing/LayoutBuilderRoutes.php Provides routes for the Layout Builder UI. 1 2
LayoutBuilderRoutesTest class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/LayoutBuilderRoutesTest.php Tests Drupal\layout_builder\Routing\LayoutBuilderRoutes.
LayoutBuilderRoutesTrait trait Drupal\layout_builder\Routing core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php Provides a trait for building routes for a Layout Builder UI. 3
LayoutBuilderSampleEntityGenerator class Drupal\layout_builder\Entity core/modules/layout_builder/src/Entity/LayoutBuilderSampleEntityGenerator.php Generates a sample entity for use by the Layout Builder. 2
LayoutBuilderSectionStorageTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderSectionStorageTest.php Tests the UI aspects of section storage.
LayoutBuilderServiceProvider class Drupal\layout_builder core/modules/layout_builder/src/LayoutBuilderServiceProvider.php Sets the layout_builder.get_block_dependency_subscriber service definition.
LayoutBuilderSortTrait trait Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderSortTrait.php LayoutBuilderSortTrait, provides callback for simulated layout change. 1
LayoutBuilderTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderTest.php Tests the Layout Builder UI.
LayoutBuilderTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderTest.php Tests the Layout Builder UI.
LayoutBuilderTestBase abstract class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderTestBase.php Tests the Layout Builder UI. 5
LayoutBuilderTestEntityHooks class Drupal\layout_builder_test\Hook core/modules/layout_builder/tests/modules/layout_builder_test/src/Hook/LayoutBuilderTestEntityHooks.php Entity hook implementations for layout_builder_test.
LayoutBuilderTestFormHooks class Drupal\layout_builder_test\Hook core/modules/layout_builder/tests/modules/layout_builder_test/src/Hook/LayoutBuilderTestFormHooks.php Form hook implementations for layout_builder_test.
LayoutBuilderTestMenuHooks class Drupal\layout_builder_test\Hook core/modules/layout_builder/tests/modules/layout_builder_test/src/Hook/LayoutBuilderTestMenuHooks.php Menu hook implementations for layout_builder_test.
LayoutBuilderTestPlugin class Drupal\layout_builder_test\Plugin\Layout core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Layout/LayoutBuilderTestPlugin.php The Layout Builder Test Plugin.

Other projects

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