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
RevisionRevertForm class Drupal\Core\Entity\Form core/lib/Drupal/Core/Entity/Form/RevisionRevertForm.php Provides a form for reverting an entity revision. 10
RevisionRevertFormTest class Drupal\FunctionalTests\Entity core/tests/Drupal/FunctionalTests/Entity/RevisionRevertFormTest.php Tests reverting a revision with revision revert form.
RevisionRouteProviderTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/RevisionRouteProviderTest.php Tests revision route provider.
RevisionRouteProviderTest class Drupal\FunctionalTests\Entity core/tests/Drupal/FunctionalTests/Entity/RevisionRouteProviderTest.php Tests revision route provider.
RevisionTestItem class Drupal\workspaces_test\Plugin\Field\FieldType core/modules/workspaces/tests/modules/workspaces_test/src/Plugin/Field/FieldType/RevisionTestItem.php Defines the 'revision_test_field' field type.
RevisionUidTest class Drupal\Tests\node\Kernel\Views core/modules/node/tests/src/Kernel/Views/RevisionUidTest.php Tests the node_revision_uid field.
RevisionUserTest class Drupal\Tests\media\Kernel\Views core/modules/media/tests/src/Kernel/Views/RevisionUserTest.php Tests the media_revision_user field.
RevisionUserTest class Drupal\Tests\block_content\Kernel\Views core/modules/block_content/tests/src/Kernel/Views/RevisionUserTest.php Tests the block_content_revision_user field.
RevisionVersionHistoryTest class Drupal\FunctionalTests\Entity core/tests/Drupal/FunctionalTests/Entity/RevisionVersionHistoryTest.php Tests version history page.
RevisionVersionHistoryTranslatableTest final class Drupal\FunctionalTests\Entity core/tests/Drupal/FunctionalTests/Entity/RevisionVersionHistoryTranslatableTest.php Tests version history page with translations.
RevisionViewTest class Drupal\FunctionalTests\Entity core/tests/Drupal/FunctionalTests/Entity/RevisionViewTest.php Tests revision view page.
RfcLoggerTrait trait Drupal\Core\Logger core/lib/Drupal/Core/Logger/RfcLoggerTrait.php A copy of \Psr\Log\LoggerTrait that uses RFC 5424 compliant log levels. 6
RfcLogLevel class Drupal\Core\Logger core/lib/Drupal/Core/Logger/RfcLogLevel.php Defines various logging severity levels. 27
Role class Drupal\user\Entity core/modules/user/src/Entity/Role.php Defines the user role entity class. 120 1
Role class Drupal\user\Plugin\views\access core/modules/user/src/Plugin/views/access/Role.php Access plugin that provides role-based access control. 1
Role class Drupal\user\Plugin\migrate\source\d6 core/modules/user/src/Plugin/migrate/source/d6/Role.php Drupal 6 role source from database. 1
Role class Drupal\user\Plugin\migrate\source\d7 core/modules/user/src/Plugin/migrate/source/d7/Role.php Drupal 7 role source from database. 1
RoleAccessCheck class Drupal\user\Access core/modules/user/src/Access/RoleAccessCheck.php Determines access to routes based on roles. 1 2
RoleAccessCheckTest class Drupal\Tests\Core\Route core/tests/Drupal/Tests/Core/Route/RoleAccessCheckTest.php Tests Drupal\user\Access\RoleAccessCheck.
RoleAccessControlHandler class Drupal\user core/modules/user/src/RoleAccessControlHandler.php Defines the access control handler for the user role entity type. 1
RoleExistsConstraint class Drupal\user\Plugin\Validation\Constraint core/modules/user/src/Plugin/Validation/Constraint/RoleExistsConstraint.php Checks if a role exists. 1
RoleExistsConstraintValidator class Drupal\user\Plugin\Validation\Constraint core/modules/user/src/Plugin/Validation/Constraint/RoleExistsConstraintValidator.php Validates that a role exists. 1
RoleExistsConstraintValidatorTest class Drupal\Tests\user\Kernel\Plugin\Validation\Constraint core/modules/user/tests/src/Kernel/Plugin/Validation/Constraint/RoleExistsConstraintValidatorTest.php Tests Role Exists Constraint Validator.
RoleForm class Drupal\user core/modules/user/src/RoleForm.php Form controller for the role entity edit forms. 1
RoleInterface interface Drupal\user core/modules/user/src/RoleInterface.php Provides an interface defining a user role entity. 1 127
RoleJsonAnonTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleJsonAnonTest.php Tests Role Json Anon.
RoleJsonBasicAuthTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleJsonBasicAuthTest.php Tests Role Json Basic Auth.
RoleJsonCookieTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleJsonCookieTest.php Tests Role Json Cookie.
RoleListBuilder class Drupal\user core/modules/user/src/RoleListBuilder.php Defines a class to build a listing of user role entities. 1
RoleResourceTestBase abstract class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleResourceTestBase.php Resource test base for the UserRole entity. 6
Roles class Drupal\user\Plugin\views\field core/modules/user/src/Plugin/views/field/Roles.php Field handler to provide a list of roles.
Roles class Drupal\user\Plugin\views\filter core/modules/user/src/Plugin/views/filter/Roles.php Filter handler for user roles.
RoleSettingsForm class Drupal\user\Form core/modules/user/src/Form/RoleSettingsForm.php Configure administrator role settings for this site. 1
RolesLookup

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

 class Drupal\block\Plugin\migrate\process core/modules/block/src/Plugin/migrate/process/RolesLookup.php Gets the destination roles ID for an array of source roles IDs.
RolesRid class Drupal\user\Plugin\views\argument core/modules/user/src/Plugin/views/argument/RolesRid.php Allow role ID(s) as argument. 1
RolesRidArgumentTest class Drupal\Tests\user\Functional\Views core/modules/user/tests/src/Functional/Views/RolesRidArgumentTest.php Tests the handler of the user: roles argument.
RolesRidTest class Drupal\Tests\user\Unit\Views\Argument core/modules/user/tests/src/Unit/Views/Argument/RolesRidTest.php Tests Drupal\user\Plugin\views\argument\RolesRid.
RoleStorage class Drupal\user core/modules/user/src/RoleStorage.php Defines the storage handler class for user roles. 1
RoleStorageInterface interface Drupal\user core/modules/user/src/RoleStorageInterface.php Defines an interface for role entity storage classes. 1 8
RoleTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/RoleTest.php JSON:API integration test for the "Role" config entity type.
RoleTest class Drupal\Tests\user\Kernel\Plugin\migrate\source\d6 core/modules/user/tests/src/Kernel/Plugin/migrate/source/d6/RoleTest.php Tests the d6_user_role source plugin.
RoleTest class Drupal\Tests\user\Kernel\Plugin\migrate\source\d7 core/modules/user/tests/src/Kernel/Plugin/migrate/source/d7/RoleTest.php Tests the d7_user_role source plugin.
RoleUserTestBase abstract class Drupal\Tests\user\Unit\Plugin\Action core/modules/user/tests/src/Unit/Plugin/Action/RoleUserTestBase.php Provides a base class for user role action tests. 2
RoleValidationTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/RoleValidationTest.php Tests validation of user_role entities.
RoleXmlAnonTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleXmlAnonTest.php Tests Role Xml Anon.
RoleXmlBasicAuthTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleXmlBasicAuthTest.php Tests Role Xml Basic Auth.
RoleXmlCookieTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleXmlCookieTest.php Tests Role Xml Cookie.
RollbackAwareInterface interface Drupal\migrate\Event core/modules/migrate/src/Event/RollbackAwareInterface.php Interface for plugins that react to pre- or post-rollback events. 1 2
RollbackFieldInstanceTest class Drupal\Tests\field\Kernel\Migrate\d7 core/modules/field/tests/src/Kernel/Migrate/d7/RollbackFieldInstanceTest.php Migrates and rolls back Drupal 7 fields.
RollbackFieldTest class Drupal\Tests\field\Kernel\Migrate\d7 core/modules/field/tests/src/Kernel/Migrate/d7/RollbackFieldTest.php Migrates and rolls back Drupal 7 fields.

Other projects

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