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
User class Drupal\user\Plugin\migrate\source\d6 core/modules/user/src/Plugin/migrate/source/d6/User.php Drupal 6 user source from database. 1
User class Drupal\user\Plugin\migrate\source\d7 core/modules/user/src/Plugin/migrate/source/d7/User.php Drupal 7 user source from database. 1
User class Drupal\user\Plugin\migrate core/modules/user/src/Plugin/migrate/User.php Plugin class for Drupal 7 user migrations dealing with fields and profiles. 2
UserAccessControlHandler class Drupal\user core/modules/user/src/UserAccessControlHandler.php Defines the access control handler for the user entity type. 2
UserAccessControlHandlerTest class Drupal\Tests\user\Unit core/modules/user/tests/src/Unit/UserAccessControlHandlerTest.php Tests the user access controller.
UserAccessTestHooks class Drupal\user_access_test\Hook core/modules/user/tests/modules/user_access_test/src/Hook/UserAccessTestHooks.php Hook implementations for user_access_test.
UserAccountFormFieldsTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/UserAccountFormFieldsTest.php Verifies the field order in user account forms.
UserAccountFormPasswordResetTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/UserAccountFormPasswordResetTest.php Verifies that the password reset behaves as expected with form elements.
UserAccountLinksTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserAccountLinksTest.php Tests user-account links.
UserActionConfigSchemaTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/UserActionConfigSchemaTest.php Tests that the config schema is valid when roles are added or removed.
UserAdminLanguageTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserAdminLanguageTest.php Tests users' ability to change their own administration language.
UserAdminListingTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserAdminListingTest.php Tests the user admin listing if views is not enabled.
UserAdminSettingsFormTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/UserAdminSettingsFormTest.php Configuration object user.mail and user.settings save test.
UserAdminTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserAdminTest.php Tests user administration page functionality.
UserAgent class Drupal\Component\Utility core/lib/Drupal/Component/Utility/UserAgent.php Provides user agent related utility functions. 3
UserAgentTest class Drupal\Tests\Component\Utility core/tests/Drupal/Tests/Component/Utility/UserAgentTest.php Tests bytes size parsing helper methods.
UserAnonymousActivateTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/UserAnonymousActivateTest.php Tests unblocking the anonymous user account.
UserAuth class Drupal\user core/modules/user/src/UserAuth.php Validates user authentication credentials. 1
UserAuthDecorator class Drupal\user_auth_decorator_test core/modules/user/tests/modules/user_auth_decorator_test/src/UserAuthDecorator.php Helper to validate UserAuthInterface BC layers are functional. 3 2
UserAuthentication class Drupal\user core/modules/user/src/UserAuthentication.php Validates user authentication credentials. 1 2
UserAuthenticationController

in drupal:11.4.0 and is removed from drupal:12.0.0. Use \Drupal\rest\Controller\RestAuthenticationController instead.

 class Drupal\user\Controller core/modules/user/src/Controller/UserAuthenticationController.php Provides controllers for login, login status and logout via HTTP requests. 1
UserAuthenticationInterface interface Drupal\user core/modules/user/src/UserAuthenticationInterface.php An interface for validating user authentication credentials. 1 4
UserAuthenticationTest class Drupal\Tests\user\Unit core/modules/user/tests/src/Unit/UserAuthenticationTest.php Tests Drupal\user\UserAuthentication.
UserAuthInterface interface Drupal\user core/modules/user/src/UserAuthInterface.php An interface for validating user authentication credentials. 2 1
UserAuthTest class Drupal\Tests\user\Unit core/modules/user/tests/src/Unit/UserAuthTest.php Tests Drupal\user\UserAuth.
UserBatchActionTest class Drupal\Tests\views\Functional core/modules/views/tests/src/Functional/UserBatchActionTest.php Tests the views bulk form with batch action.
UserBlocksTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserBlocksTest.php Tests user blocks.
UserBulkForm class Drupal\user\Plugin\views\field core/modules/user/src/Plugin/views/field/UserBulkForm.php Defines a user operations bulk form element. 1
UserBulkFormTest class Drupal\Tests\user\Unit\Plugin\views\field core/modules/user/tests/src/Unit/Plugin/views/field/UserBulkFormTest.php Tests Drupal\user\Plugin\views\field\UserBulkForm.
UserCacheContext class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/UserCacheContext.php Defines the UserCacheContext service, for "per user" caching. 2
UserCacheContextBase abstract class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/UserCacheContextBase.php Base class for user-based cache contexts. 5 1
UserCacheTagsTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserCacheTagsTest.php Tests the User entity's cache tags.
UserCancelForm class Drupal\user\Form core/modules/user/src/Form/UserCancelForm.php Provides a confirmation form for cancelling user account. 1
UserCancelMethodsConstraint class Drupal\user\Plugin\Validation\Constraint core/modules/user/src/Plugin/Validation/Constraint/UserCancelMethodsConstraint.php Constraint for the user cancel method.
UserCancelTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserCancelTest.php Ensure that account cancellation methods work as expected.
UserChangedTest class Drupal\Tests\user\Functional\Views core/modules/user/tests/src/Functional/Views/UserChangedTest.php Tests the changed field.
UserConfigValidationTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/UserConfigValidationTest.php Tests validating user modules' configuration.
UserContextAccessPolicy class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/AccessPolicyProcessorTest.php A test access policy class that sets a context.
UserController class Drupal\user\Controller core/modules/user/src/Controller/UserController.php Controller routines for user routes. 1
UserControllerTest class Drupal\Tests\user\Kernel\Controller core/modules/user/tests/src/Kernel/Controller/UserControllerTest.php Tests for the User controller.
UserCreateFailMailTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserCreateFailMailTest.php Tests the create user administration page.
UserCreateTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserCreateTest.php Tests the create user administration page.
UserCreationTrait trait Drupal\Tests\user\Traits core/modules/user/tests/src/Traits/UserCreationTrait.php Provides test methods for user creation and authentication. 129
UserData class Drupal\user\Plugin\views\field core/modules/user/src/Plugin/views/field/UserData.php Provides access to the user data service.
UserData class Drupal\user\Plugin\migrate\destination core/modules/user/src/Plugin/migrate/destination/UserData.php Migration destination for user data. 1
UserData class Drupal\user core/modules/user/src/UserData.php Defines the user data service. 1 2
UserDataInterface interface Drupal\user core/modules/user/src/UserDataInterface.php Defines the user data service interface. 1 6
UserDataTest class Drupal\Tests\user\Kernel\Views core/modules/user/tests/src/Kernel/Views/UserDataTest.php Tests the user data service field handler.
UserDeleteTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/UserDeleteTest.php Tests deleting of user accounts.
UserEditedOwnAccountTest class Drupal\Tests\user\Functional core/modules/user/tests/src/Functional/UserEditedOwnAccountTest.php Tests user edited own account can still log in.

Other projects

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