Classes, traits, and interfaces - 8.9.x - 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 1511

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
Mail		class	Drupal\Component\Utility	core/lib/Drupal/Component/Utility/Mail.php	Provides helpers to ensure emails are compliant with RFCs.		2
Mail		class	Drupal\Core\Annotation	core/lib/Drupal/Core/Annotation/Mail.php	Defines a Mail annotation object.
MailCaptureTest		class	Drupal\FunctionalTests	core/tests/Drupal/FunctionalTests/MailCaptureTest.php	Tests the SimpleTest email capturing logic, the assertMail assertion and the drupalGetMails function.
MailFormatHelper		class	Drupal\Core\Mail	core/lib/Drupal/Core/Mail/MailFormatHelper.php	Defines a class containing utility methods for formatting mail messages.		6
MailFormatHelperTest		class	Drupal\Tests\Core\Mail	core/tests/Drupal/Tests/Core/Mail/MailFormatHelperTest.php	@coversDefaultClass \Drupal\Core\Mail\MailFormatHelper @group Mail
MailHandler		class	Drupal\contact	core/modules/contact/src/MailHandler.php	Provides a class for handling assembly and dispatch of contact mail messages.		1	2
MailHandlerException		class	Drupal\contact	core/modules/contact/src/MailHandlerException.php	Exception thrown by MailHandler when unable to determine message recipient.		1
MailHandlerInterface		interface	Drupal\contact	core/modules/contact/src/MailHandlerInterface.php	Provides an interface for assembly and dispatch of contact mail messages.	1
MailHandlerTest		class	Drupal\Tests\contact\Unit	core/modules/contact/tests/src/Unit/MailHandlerTest.php	@coversDefaultClass \Drupal\contact\MailHandler @group contact
MailInterface		interface	Drupal\Core\Mail	core/lib/Drupal/Core/Mail/MailInterface.php	Defines an interface for pluggable mail back-ends.	3	3
MailManager		class	Drupal\Core\Mail	core/lib/Drupal/Core/Mail/MailManager.php	Provides a Mail plugin manager.	1	1	2
MailManagerInterface		interface	Drupal\Core\Mail	core/lib/Drupal/Core/Mail/MailManagerInterface.php	Provides an interface for sending mail.	1	2
MailManagerTest		class	Drupal\Tests\Core\Mail	core/tests/Drupal/Tests/Core/Mail/MailManagerTest.php	@coversDefaultClass \Drupal\Core\Mail\MailManager @group Mail
MailTest		class	Drupal\Tests\Component\Utility	core/tests/Drupal/Tests/Component/Utility/MailTest.php	Test mail helpers implemented in Mail component.
MailTest		class	Drupal\Tests\system\Kernel\Mail	core/modules/system/tests/src/Kernel/Mail/MailTest.php	Performs tests on the pluggable mailing framework.
MailToFormatter		class	Drupal\Core\Field\Plugin\Field\FieldFormatter	core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/MailToFormatter.php	Plugin implementation of the 'email_mailto' formatter.
MainContentBlockPluginInterface		interface	Drupal\Core\Block	core/lib/Drupal/Core/Block/MainContentBlockPluginInterface.php	The interface for "main page content" blocks.	1	3
MainContentFallbackTest		class	Drupal\Tests\system\Functional\System	core/modules/system/tests/src/Functional/System/MainContentFallbackTest.php	Test SimplePageVariant main content rendering fallback page display variant.
MainContentRendererInterface		interface	Drupal\Core\Render\MainContent	core/lib/Drupal/Core/Render/MainContent/MainContentRendererInterface.php	The interface for "main content" (	4	2
MainContentRenderersPass		class	Drupal\Core\Render\MainContent	core/lib/Drupal/Core/Render/MainContent/MainContentRenderersPass.php	Adds main_content_renderers parameter to the container.		1
MainContentViewSubscriber		class	Drupal\Core\EventSubscriber	core/lib/Drupal/Core/EventSubscriber/MainContentViewSubscriber.php	View subscriber rendering main content render arrays into responses.		31	2
MaintenanceMode		class	Drupal\Core\Site	core/lib/Drupal/Core/Site/MaintenanceMode.php	Provides the default implementation of the maintenance mode service.			2
MaintenanceModeInterface		interface	Drupal\Core\Site	core/lib/Drupal/Core/Site/MaintenanceModeInterface.php	Defines the interface for the maintenance mode service.	1	2
MaintenanceModeSubscriber		class	Drupal\Core\EventSubscriber	core/lib/Drupal/Core/EventSubscriber/MaintenanceModeSubscriber.php	Maintenance mode subscriber for controller requests.			2
MaintenanceModeSubscriber		class	Drupal\user\EventSubscriber	core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php	Maintenance mode subscriber to log out users.			2
MaintenanceThemeTest		class	Drupal\KernelTests\Core\Theme	core/tests/Drupal/KernelTests/Core/Theme/MaintenanceThemeTest.php	Tests themes and base themes are correctly loaded.
MakeLayoutUntranslatableUpdatePathTestBase		abstract class	Drupal\Tests\layout_builder\Functional\Update\Translatability	core/modules/layout_builder/tests/src/Functional/Update/Translatability/MakeLayoutUntranslatableUpdatePathTestBase.php	Base class for upgrade path for translatable layouts.	2
MakeUniqueBase		abstract class	Drupal\migrate\Plugin\migrate\process	core/modules/migrate/src/Plugin/migrate/process/MakeUniqueBase.php	This plugin ensures the source value is unique.	2
MakeUniqueEntityField		class	Drupal\migrate\Plugin\migrate\process	core/modules/migrate/src/Plugin/migrate/process/MakeUniqueEntityField.php	Ensures the source value is made unique against an entity field.	1	1
MakeUniqueEntityFieldTest		class	Drupal\Tests\migrate\Unit\process	core/modules/migrate/tests/src/Unit/process/MakeUniqueEntityFieldTest.php	@coversDefaultClass \Drupal\migrate\Plugin\migrate\process\MakeUniqueEntityField @group migrate
ManagedFile		class	Drupal\file\Element	core/modules/file/src/Element/ManagedFile.php	Provides an AJAX/progress aware widget for uploading and saving a file.		1
ManageDisplayTest		class	Drupal\Tests\field_ui\FunctionalJavascript	core/modules/field_ui/tests/src/FunctionalJavascript/ManageDisplayTest.php	Tests the Field UI "Manage display" and "Manage form display" screens.
ManageDisplayTest		class	Drupal\Tests\field_ui\Functional	core/modules/field_ui/tests/src/Functional/ManageDisplayTest.php	Tests the Field UI "Manage display" and "Manage form display" screens.
ManagedStorage		final class	Drupal\Core\Config	core/lib/Drupal/Core/Config/ManagedStorage.php	The managed storage defers all the storage method calls to the manager.		1	2
ManagedStorageTest		class	Drupal\KernelTests\Core\Config\Storage	core/tests/Drupal/KernelTests/Core/Config/Storage/ManagedStorageTest.php	Tests ManagedStorage operations.
ManageFieldsFunctionalTest		class	Drupal\Tests\field_ui\Functional	core/modules/field_ui/tests/src/Functional/ManageFieldsFunctionalTest.php	Tests the Field UI "Manage fields" screen.
ManageFieldsTest		class	Drupal\Tests\field_ui\Functional	core/modules/field_ui/tests/src/Functional/ManageFieldsTest.php	Tests the Manage Display page of a fieldable entity type.
ManageGitIgnore		class	Drupal\Composer\Plugin\Scaffold	composer/Plugin/Scaffold/ManageGitIgnore.php	Manage the .gitignore file.
ManageGitIgnoreTest		class	Drupal\Tests\Composer\Plugin\Scaffold\Functional	core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Functional/ManageGitIgnoreTest.php	Tests to see whether .gitignore files are correctly managed.
ManageOptions		class	Drupal\Composer\Plugin\Scaffold	composer/Plugin/Scaffold/ManageOptions.php	Per-project options from the 'extras' section of the composer.json file.
ManyPlaceholderTest		class	Drupal\Tests\big_pipe\Unit\Render	core/modules/big_pipe/tests/src/Unit/Render/ManyPlaceholderTest.php	@coversDefaultClass \Drupal\big_pipe\Render\BigPipe @group big_pipe
ManyToOne		class	Drupal\views\Plugin\views\filter	core/modules/views/src/Plugin/views/filter/ManyToOne.php	Complex filter to handle filtering for many to one relationships, such as terms (many terms per node) or roles (many roles per user).	4	4
ManyToOne		class	Drupal\views\Plugin\views\argument	core/modules/views/src/Plugin/views/argument/ManyToOne.php	An argument handler for use in fields that have a many to one relationship with the table(s) to the left. This adds a bunch of options that are reasonably common with this type of relationship. Definition terms:	2	2
ManyToOneHelper		class	Drupal\views	core/modules/views/src/ManyToOneHelper.php	This many to one helper object is used on both arguments and filters.		3
Map		class	Drupal\Core\TypedData\Plugin\DataType	core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php	The "map" data type.	1	1
MapBaseFieldTest		class	Drupal\KernelTests\Core\Field	core/tests/Drupal/KernelTests/Core/Field/MapBaseFieldTest.php	Tests map base fields.
MapDataDefinition		class	Drupal\Core\TypedData	core/lib/Drupal/Core/TypedData/MapDataDefinition.php	A typed data definition class for defining maps.		6	1
MapDataNormalizerTest		class	Drupal\Tests\serialization\Kernel	core/modules/serialization/tests/src/Kernel/MapDataNormalizerTest.php	@group typedData
MapFieldItemList		class	Drupal\Core\Field	core/lib/Drupal/Core/Field/MapFieldItemList.php	Defines a item list class for map fields.
MapItem		class	Drupal\Core\Field\Plugin\Field\FieldType	core/lib/Drupal/Core/Field/Plugin/Field/FieldType/MapItem.php	Defines the 'map' entity field type.

Other projects

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