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
EntityMalformedException class Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityMalformedException.php Defines an exception thrown when a malformed entity is passed. 10
EntityMethod final class Drupal\Core\Config\Action\Plugin\ConfigAction core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/EntityMethod.php Makes config entity methods with the ActionMethod attribute into actions.
EntityMethodConfigActionsTest class Drupal\KernelTests\Core\Recipe core/tests/Drupal/KernelTests/Core/Recipe/EntityMethodConfigActionsTest.php Tests entity method config actions.
EntityMethodDeriver final class Drupal\Core\Config\Action\Plugin\ConfigAction\Deriver core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/Deriver/EntityMethodDeriver.php Derives config action methods from attributed config entity methods. 1
EntityMethodException final class Drupal\Core\Config\Action core/lib/Drupal/Core/Config/Action/EntityMethodException.php @internal This API is experimental. 3
EntityModerationForm class Drupal\content_moderation\Form core/modules/content_moderation/src/Form/EntityModerationForm.php The EntityModerationForm provides a simple UI for changing moderation state. 1
EntityModerationRouteProvider class Drupal\content_moderation\Entity\Routing core/modules/content_moderation/src/Entity/Routing/EntityModerationRouteProvider.php Dynamic route provider for the Content moderation module. 1
EntityNodeType class Drupal\node\Plugin\migrate\destination core/modules/node/src/Plugin/migrate/destination/EntityNodeType.php Migration destination for node type entity.
EntityNonRevisionableTranslatableFieldTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityNonRevisionableTranslatableFieldTest.php Tests translating a non-revisionable field.
EntityNormalizer class Drupal\serialization\Normalizer core/modules/serialization/src/Normalizer/EntityNormalizer.php Normalizes/denormalizes Drupal entity objects into an array structure. 2 1 2
EntityNormalizerTest class Drupal\Tests\serialization\Unit\Normalizer core/modules/serialization/tests/src/Unit/Normalizer/EntityNormalizerTest.php Tests Drupal\serialization\Normalizer\EntityNormalizer.
EntityOperations class Drupal\views\Plugin\views\field core/modules/views/src/Plugin/views/field/EntityOperations.php Renders all operations links for an entity. 1
EntityOperations class Drupal\content_moderation core/modules/content_moderation/src/EntityOperations.php Defines a class for reacting to entity events. 2
EntityOperations class Drupal\workspaces\Hook core/modules/workspaces/src/Hook/EntityOperations.php Defines a class for reacting to entity runtime hooks.
EntityOperationsCacheabilityTest class Drupal\Tests\system\Kernel\Entity core/modules/system/tests/src/Kernel/Entity/EntityOperationsCacheabilityTest.php Tests cacheability added by entity operations. 1 1
EntityOperationsTest class Drupal\Tests\system\Functional\Entity core/modules/system/tests/src/Functional/Entity/EntityOperationsTest.php Tests that operations can be injected from the hook.
EntityOperationsTest class Drupal\Tests\content_moderation\Kernel core/modules/content_moderation/tests/src/Kernel/EntityOperationsTest.php Tests Drupal\content_moderation\EntityOperations.
EntityOperationsTest class Drupal\Tests\system\Kernel\Entity core/modules/system/tests/src/Kernel/Entity/EntityOperationsTest.php Tests that operations can be injected from the hook.
EntityOperationsUnitTest class Drupal\Tests\views\Unit\Plugin\views\field core/modules/views/tests/src/Unit/Plugin/views/field/EntityOperationsUnitTest.php Tests Drupal\views\Plugin\views\field\EntityOperations.
EntityOwnerInterface interface Drupal\user core/modules/user/src/EntityOwnerInterface.php Defines a common interface for entities that have an owner. 7 17
EntityOwnerTrait trait Drupal\user core/modules/user/src/EntityOwnerTrait.php Provides a trait for entities that have an owner. 6
EntityPermissionsForm class Drupal\user\Form core/modules/user/src/Form/EntityPermissionsForm.php Provides the permissions administration form for a bundle. 1
EntityPermissionsFormTest class Drupal\Tests\user\Unit\Form core/modules/user/tests/src/Unit/Form/EntityPermissionsFormTest.php Tests the permissions administration form for a bundle.
EntityPermissionsRouteProvider class Drupal\user\Entity core/modules/user/src/Entity/EntityPermissionsRouteProvider.php Provides routes for the entity permissions form. 1 6
EntityPermissionsRouteProviderWithCheck

in drupal:11.1.0 and is removed from drupal:12.0.0. Use EntityPermissionsRouteProvider instead.

 class Drupal\user\Entity core/modules/user/src/Entity/EntityPermissionsRouteProviderWithCheck.php Provides routes for the entity permissions form with a custom access check. 1
EntityPermissionsRouteProviderWithCheckTest class Drupal\Tests\user\Unit\Entity core/modules/user/tests/src/Unit/Entity/EntityPermissionsRouteProviderWithCheckTest.php Tests the route provider deprecation.
EntityPublishedActionDeriver class Drupal\Core\Action\Plugin\Action\Derivative core/lib/Drupal/Core/Action/Plugin/Action/Derivative/EntityPublishedActionDeriver.php Provides an action deriver that finds publishable entity types. 3
EntityPublishedInterface interface Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityPublishedInterface.php Provides an interface for access to an entity's published state. 11 28
EntityPublishedTrait trait Drupal\Core\Entity core/lib/Drupal/Core/Entity/EntityPublishedTrait.php Provides a trait for published status. 5
EntityQueryAccessTest class Drupal\Tests\views\Functional\Entity core/modules/views/tests/src/Functional/Entity/EntityQueryAccessTest.php Tests that Views respects 'ENTITY_TYPE_access' query tags.
EntityQueryAggregateTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityQueryAggregateTest.php Tests the Entity Query Aggregation API.
EntityQueryRelationshipTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityQueryRelationshipTest.php Tests the Entity Query relationship API.
EntityQueryTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/EntityQueryTest.php Tests Entity Query functionality.
EntityReference class Drupal\views\Plugin\views\row core/modules/views/src/Plugin/views/row/EntityReference.php EntityReference row plugin.
EntityReference class Drupal\views\Plugin\views\display core/modules/views/src/Plugin/views/display/EntityReference.php The plugin that handles an EntityReference display.
EntityReference class Drupal\views\Plugin\views\filter core/modules/views/src/Plugin/views/filter/EntityReference.php Filters a view by entity references. 1
EntityReference class Drupal\views\Plugin\views\style core/modules/views/src/Plugin/views/style/EntityReference.php EntityReference style plugin.
EntityReference class Drupal\Core\Entity\Plugin\DataType core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php Defines an 'entity_reference' data type. 2
EntityReference class Drupal\field\Plugin\migrate\field\d7 core/modules/field/src/Plugin/migrate/field/d7/EntityReference.php MigrateField plugin for Drupal 7 entity_reference fields.
EntityReferenceAdminTest class Drupal\Tests\field\FunctionalJavascript\EntityReference core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php Tests for the administrative UI.
EntityReferenceAdminTest class Drupal\Tests\field\Functional\EntityReference core/modules/field/tests/src/Functional/EntityReference/EntityReferenceAdminTest.php Tests for the administrative UI.
EntityReferenceArgument class Drupal\views\Plugin\views\argument core/modules/views/src/Plugin/views/argument/EntityReferenceArgument.php Argument handler to accept an entity reference ID value.
EntityReferenceAutocompleteTagsWidget class Drupal\Core\Field\Plugin\Field\FieldWidget core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteTagsWidget.php Plugin implementation of the 'entity_reference_autocomplete_tags' widget.
EntityReferenceAutocompleteWidget class Drupal\Core\Field\Plugin\Field\FieldWidget core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php Plugin implementation of the 'entity_reference_autocomplete' widget. 1
EntityReferenceAutocompleteWidgetTest class Drupal\FunctionalJavascriptTests\EntityReference core/tests/Drupal/FunctionalJavascriptTests/EntityReference/EntityReferenceAutocompleteWidgetTest.php Tests the output of entity reference autocomplete widgets.
EntityReferenceAutoCreateTest class Drupal\Tests\field\Functional\EntityReference core/modules/field/tests/src/Functional/EntityReference/EntityReferenceAutoCreateTest.php Tests creating new entity (e.g. taxonomy-term) from an autocomplete widget.
EntityReferenceEntityFormatter class Drupal\Core\Field\Plugin\Field\FieldFormatter core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceEntityFormatter.php Plugin implementation of the 'entity reference rendered entity' formatter.
EntityReferenceFieldCreationTest class Drupal\Tests\system\Functional\Entity core/modules/system/tests/src/Functional/Entity/EntityReferenceFieldCreationTest.php Tests creating entity reference fields in the UI.
EntityReferenceFieldCreationTrait trait Drupal\Tests\field\Traits core/modules/field/tests/src/Traits/EntityReferenceFieldCreationTrait.php Provides common functionality for the EntityReference test classes. 52
EntityReferenceFieldDefaultValueTest class Drupal\Tests\field\Functional\EntityReference core/modules/field/tests/src/Functional/EntityReference/EntityReferenceFieldDefaultValueTest.php Tests entity reference field default values storage in CMI.

Other projects

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