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
LinksetControllerMultiLingualTest		final class	Drupal\Tests\system\Functional\Menu	core/modules/system/tests/src/Functional/Menu/LinksetControllerMultiLingualTest.php	Tests the behavior of the linkset controller in multilingual setup.
LinksetControllerTest		final class	Drupal\Tests\system\Functional\Menu	core/modules/system/tests/src/Functional/Menu/LinksetControllerTest.php	Tests the behavior of the linkset controller.
LinksetControllerTestBase		abstract class	Drupal\Tests\system\Functional\Menu	core/modules/system/tests/src/Functional/Menu/LinksetControllerTestBase.php	A base class for implementing LinksetController tests.	2
LinkTest		class	Drupal\Tests\jsonapi\Unit\JsonApiResource	core/modules/jsonapi/tests/src/Unit/JsonApiResource/LinkTest.php	Tests Drupal\jsonapi\JsonApiResource\Link.
LinkTestBaseFieldHooks		class	Drupal\link_test_base_field\Hook	core/modules/link/tests/modules/link_test_base_field/src/Hook/LinkTestBaseFieldHooks.php	Hook implementations for link_test_base_field.
LinkThemeHooks		class	Drupal\link\Hook	core/modules/link/src/Hook/LinkThemeHooks.php	Theme hooks for link.		1
LinkTitleRequiredConstraint		class	Drupal\link\Plugin\Validation\Constraint	core/modules/link/src/Plugin/Validation/Constraint/LinkTitleRequiredConstraint.php	Validation constraint for link title subfields if a URL was entered.		1
LinkTitleRequiredConstraintValidator		class	Drupal\link\Plugin\Validation\Constraint	core/modules/link/src/Plugin/Validation/Constraint/LinkTitleRequiredConstraintValidator.php	Constraint validator for link title subfields if a URL was entered.		1
LinkTitleRequiredConstraintValidatorTest		class	Drupal\Tests\link\Unit\Plugin\Validation\Constraint	core/modules/link/tests/src/Unit/Plugin/Validation/Constraint/LinkTitleRequiredConstraintValidatorTest.php	Tests LinkTitleRequiredConstraintValidator::validate().
LinkTypeConstraint		class	Drupal\link\Plugin\Validation\Constraint	core/modules/link/src/Plugin/Validation/Constraint/LinkTypeConstraint.php	Validation constraint for links receiving data allowed by its settings.		1
LinkTypeConstraintValidator		class	Drupal\link\Plugin\Validation\Constraint	core/modules/link/src/Plugin/Validation/Constraint/LinkTypeConstraintValidator.php	Constraint validator for links receiving data allowed by its settings.		1
LinkTypeConstraintValidatorTest		class	Drupal\Tests\link\Unit\Plugin\Validation\Constraint	core/modules/link/tests/src/Unit/Plugin/Validation/Constraint/LinkTypeConstraintValidatorTest.php	Tests LinkTypeConstraintValidator.
LinkUri		class	Drupal\migrate\Plugin\migrate\process	core/modules/migrate/src/Plugin/migrate/process/LinkUri.php	Generates an internal URI from the source value.		1
LinkUri	in drupal:11.4.0 and is removed from drupal:13.0.0. Use \Drupal\migrate\Plugin\migrate\process\LinkUri instead. Converts the source path value to an 'entity:', 'internal:' or 'base:' URI. Available configuration keys: source: A source path to be converted into an URI. validate_route: (optional) Whether the plugin should validate that the URI derived from the source link path has a valid Drupal route. TRUE: Throw a MigrateException if the resulting URI is not routed. This value is the default. FALSE: Return the URI for the unrouted path. Examples:	class	Drupal\menu_link_content\Plugin\migrate\process	core/modules/menu_link_content/src/Plugin/migrate/process/LinkUri.php	Generates an internal URI from the source value.		1
LinkUriTest		class	Drupal\Tests\menu_link_content\Kernel\Plugin\migrate\process	core/modules/menu_link_content/tests/src/Kernel/Plugin/migrate/process/LinkUriTest.php	Tests \Drupal\menu_link_content\Plugin\migrate\process\LinkUri.
LinkUriTest		class	Drupal\Tests\migrate\Kernel\process	core/modules/migrate/tests/src/Kernel/process/LinkUriTest.php	Tests \Drupal\migrate\Plugin\migrate\process\LinkUri.
LinkViewsTokensTest		class	Drupal\Tests\link\Functional\Views	core/modules/link/tests/src/Functional/Views/LinkViewsTokensTest.php	Tests the views integration for link tokens.
LinkWidget		class	Drupal\link\Plugin\Field\FieldWidget	core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php	Plugin implementation of the 'link' widget.
ListCacheBinsPass		class	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/ListCacheBinsPass.php	Adds cache_bins parameter to the container.		1
ListDataDefinition		class	Drupal\Core\TypedData	core/lib/Drupal/Core/TypedData/ListDataDefinition.php	A typed data definition class for defining lists.	3	7
ListDataDefinitionInterface		interface	Drupal\Core\TypedData	core/lib/Drupal/Core/TypedData/ListDataDefinitionInterface.php	Interface for data definitions of lists.	2	4
ListElement		class	Drupal\config_translation\FormElement	core/modules/config_translation/src/FormElement/ListElement.php	Defines the list element for the configuration translation interface.
ListField		class	Drupal\options\Plugin\views\filter	core/modules/options/src/Plugin/views/filter/ListField.php	Filter handler which uses list-fields as options.
ListField		class	Drupal\options\Plugin\migrate\field\d7	core/modules/options/src/Plugin/migrate/field/d7/ListField.php	Migrate field plugin for Drupal 7 list fields.
ListFloatItem		class	Drupal\options\Plugin\Field\FieldType	core/modules/options/src/Plugin/Field/FieldType/ListFloatItem.php	Plugin implementation of the 'list_float' field type.
ListingEmpty		class	Drupal\node\Plugin\views\area	core/modules/node/src/Plugin/views/area/ListingEmpty.php	Defines an area plugin to display a node/add link.
ListingEmpty	in drupal:11.3.0 and is removed from drupal:13.0.0. There is no replacement.	class	Drupal\block_content\Plugin\views\area	core/modules/block_content/src/Plugin/views/area/ListingEmpty.php	Defines an area plugin to display a block add link.
ListIntegerItem		class	Drupal\options\Plugin\Field\FieldType	core/modules/options/src/Plugin/Field/FieldType/ListIntegerItem.php	Plugin implementation of the 'list_integer' field type.		1
ListInterface		interface	Drupal\Core\TypedData	core/lib/Drupal/Core/TypedData/ListInterface.php	Interface for a list of typed data.	2	7
ListItemBase		abstract class	Drupal\options\Plugin\Field\FieldType	core/modules/options/src/Plugin/Field/FieldType/ListItemBase.php	Plugin base class inherited by the options field types.	3
ListNormalizer		class	Drupal\serialization\Normalizer	core/modules/serialization/src/Normalizer/ListNormalizer.php	Converts list objects to arrays.	1	1	2
ListNormalizerTest		class	Drupal\Tests\serialization\Unit\Normalizer	core/modules/serialization/tests/src/Unit/Normalizer/ListNormalizerTest.php	Tests Drupal\serialization\Normalizer\ListNormalizer.
ListPlugin		class	Drupal\ckeditor5\Plugin\CKEditor5Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/ListPlugin.php	CKEditor 5 List plugin.		1	1
ListPluginTest		class	Drupal\Tests\ckeditor5\Unit	core/modules/ckeditor5/tests/src/Unit/ListPluginTest.php	Tests Drupal\ckeditor5\Plugin\CKEditor5Plugin\ListPlugin.
ListStringItem		class	Drupal\options\Plugin\Field\FieldType	core/modules/options/src/Plugin/Field/FieldType/ListStringItem.php	Plugin implementation of the 'list_string' field type.
LoadMultipleTest		class	Drupal\Tests\taxonomy\Kernel	core/modules/taxonomy/tests/src/Kernel/LoadMultipleTest.php	Tests the loading of multiple taxonomy terms at once.
LoadTest		class	Drupal\Tests\file\Kernel	core/modules/file/tests/src/Kernel/LoadTest.php	Tests \Drupal\file\Entity\File::load().
LocalActionDefault		class	Drupal\Core\Menu	core/lib/Drupal/Core/Menu/LocalActionDefault.php	Provides a default implementation for local action plugins.	7	8	2
LocalActionDefaultTest		class	Drupal\Tests\Core\Menu	core/tests/Drupal/Tests/Core/Menu/LocalActionDefaultTest.php	Tests Drupal\Core\Menu\LocalActionDefault.
LocalActionInterface		interface	Drupal\Core\Menu	core/lib/Drupal/Core/Menu/LocalActionInterface.php	Defines an interface for menu local actions.	1
LocalActionManager		class	Drupal\Core\Menu	core/lib/Drupal/Core/Menu/LocalActionManager.php	Provides the default local action manager using YML as primary definition.	1	2	2
LocalActionManagerInterface		interface	Drupal\Core\Menu	core/lib/Drupal/Core/Menu/LocalActionManagerInterface.php	Manages discovery and instantiation of menu local action plugins.	1	2
LocalActionManagerTest		class	Drupal\Tests\Core\Menu	core/tests/Drupal/Tests/Core/Menu/LocalActionManagerTest.php	Tests Drupal\Core\Menu\LocalActionManager.
LocalActionManagerTest		class	Drupal\KernelTests\Core\Menu	core/tests/Drupal/KernelTests/Core/Menu/LocalActionManagerTest.php	Tests the local action manager.
LocalActionsBlock		class	Drupal\Core\Menu\Plugin\Block	core/lib/Drupal/Core/Menu/Plugin/Block/LocalActionsBlock.php	Provides a block to display the local actions.
LocalActionTest		class	Drupal\Tests\block_content\Functional	core/modules/block_content/tests/src/Functional/LocalActionTest.php	Tests block_content local action links.
LocalActionTest		class	Drupal\Tests\system\Functional\Menu	core/modules/system/tests/src/Functional/Menu/LocalActionTest.php	Tests local actions derived from router and added/altered via hooks.
LocalActionTest		class	Drupal\menu_test\Plugin\Derivative	core/modules/system/tests/modules/menu_test/src/Plugin/Derivative/LocalActionTest.php	Test derivative to check local action title escaping.			1
LocalActionWithDestination		class	Drupal\Core\Menu	core/lib/Drupal/Core/Menu/LocalActionWithDestination.php	Modifies the local action to add a destination.			1
LocalAwareRedirectResponseTrait		trait	Drupal\Core\Routing	core/lib/Drupal/Core/Routing/LocalAwareRedirectResponseTrait.php	Provides a trait which ensures that a URL is safe to redirect to.

Other projects

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