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

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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.
LayoutBuilderTestPluginHooks class Drupal\layout_builder_test\Hook core/modules/layout_builder/tests/modules/layout_builder_test/src/Hook/LayoutBuilderTestPluginHooks.php Plugin hook implementations for layout_builder_test.
LayoutBuilderTestThemeHooks class Drupal\layout_builder_test\Hook core/modules/layout_builder/tests/modules/layout_builder_test/src/Hook/LayoutBuilderTestThemeHooks.php Theme hook implementations for layout_builder_test.
LayoutBuilderThemeHooks class Drupal\layout_builder\Hook core/modules/layout_builder/src/Hook/LayoutBuilderThemeHooks.php Hook implementations for layout_builder.
LayoutBuilderThemeSuggestionsTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderThemeSuggestionsTest.php Tests template suggestions.
LayoutBuilderThemeSuggestionsTestThemeHooks class Drupal\layout_builder_theme_suggestions_test\Hook core/modules/layout_builder/tests/modules/layout_builder_theme_suggestions_test/src/Hook/LayoutBuilderThemeSuggestionsTestThemeHooks.php Theme hook implementations for layout_builder_theme_suggestions_test.
LayoutBuilderToolbarTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderToolbarTest.php Test Layout Builder integration with Toolbar.
LayoutBuilderTranslationTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderTranslationTest.php Tests that the Layout Builder works with translated content.
LayoutBuilderUiCacheContext class Drupal\layout_builder\Cache core/modules/layout_builder/src/Cache/LayoutBuilderUiCacheContext.php Determines if an entity is being viewed in the Layout Builder UI. 2
LayoutBuilderUiTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderUiTest.php Tests the Layout Builder UI.
LayoutBuilderViewModeTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutBuilderViewModeTest.php Tests the Layout Builder UI with view modes.
LayoutBuilderWidget class Drupal\layout_builder\Plugin\Field\FieldWidget core/modules/layout_builder/src/Plugin/Field/FieldWidget/LayoutBuilderWidget.php A widget to display the layout form.
LayoutDefault class Drupal\Core\Layout core/lib/Drupal/Core/Layout/LayoutDefault.php Provides a default class for Layout plugins. 8 13 2
LayoutDefaultTest class Drupal\Tests\Core\Layout core/tests/Drupal/Tests/Core/Layout/LayoutDefaultTest.php Tests Drupal\Core\Layout\LayoutDefault.
LayoutDefinition class Drupal\Core\Layout core/lib/Drupal/Core/Layout/LayoutDefinition.php Provides an implementation of a layout definition and its metadata. 7
LayoutDeriver class Drupal\Tests\Core\Layout core/tests/Drupal/Tests/Core/Layout/LayoutPluginManagerTest.php Provides a dynamic layout deriver for the test.
LayoutDiscoveryHooks class Drupal\layout_discovery\Hook core/modules/layout_discovery/src/Hook/LayoutDiscoveryHooks.php Hook implementations for layout_discovery.
LayoutDiscoveryRequirements class Drupal\layout_discovery\Install\Requirements core/modules/layout_discovery/src/Install/Requirements/LayoutDiscoveryRequirements.php Install time requirements for the layout_discovery module.
LayoutDiscoveryThemeHooks class Drupal\layout_discovery\Hook core/modules/layout_discovery/src/Hook/LayoutDiscoveryThemeHooks.php Theme hooks for layout_discovery. 3
LayoutDisplayTest class Drupal\Tests\layout_builder\Functional core/modules/layout_builder/tests/src/Functional/LayoutDisplayTest.php Tests functionality of the entity view display with regard to Layout Builder.
LayoutEntityDisplayInterface interface Drupal\layout_builder\Entity core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php Provides an interface for entity displays that have layout. 1 10
LayoutEntityDisplayNormalizer class Drupal\layout_builder\Normalizer core/modules/layout_builder/src/Normalizer/LayoutEntityDisplayNormalizer.php Normalizes/denormalizes LayoutEntityDisplay objects into an array structure. 1
LayoutEntityHelperTrait trait Drupal\layout_builder core/modules/layout_builder/src/LayoutEntityHelperTrait.php Methods to help with entities using the layout builder. 5

Other projects


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