Classes, traits, and interfaces - 10.3.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 1518

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
MessageCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/MessageCommand.php AJAX command for a JavaScript Drupal.message() call. 6
MessageCommandTest class Drupal\FunctionalJavascriptTests\Ajax core/tests/Drupal/FunctionalJavascriptTests/Ajax/MessageCommandTest.php Tests adding messages via AJAX command.
MessageEntityTest class Drupal\Tests\contact\Kernel core/modules/contact/tests/src/Kernel/MessageEntityTest.php Tests the message entity class.
MessageForm class Drupal\contact core/modules/contact/src/MessageForm.php Form controller for contact message forms.
MessageForm class Drupal\migrate\Form core/modules/migrate/src/Form/MessageForm.php Migrate messages form.
MessageInterface interface Drupal\contact core/modules/contact/src/MessageInterface.php Provides an interface defining a contact message entity. 1 1
MessageJsonAnonTest class Drupal\Tests\contact\Functional\Rest core/modules/contact/tests/src/Functional/Rest/MessageJsonAnonTest.php @group rest
MessageJsonBasicAuthTest class Drupal\Tests\contact\Functional\Rest core/modules/contact/tests/src/Functional/Rest/MessageJsonBasicAuthTest.php @group rest
MessageJsonCookieTest class Drupal\Tests\contact\Functional\Rest core/modules/contact/tests/src/Functional/Rest/MessageJsonCookieTest.php @group rest
MessagePlugin class Drupal\Composer\Plugin\ProjectMessage composer/Plugin/ProjectMessage/MessagePlugin.php A Composer plugin to display a message after creating a project.
MessageResourceTestBase abstract class Drupal\Tests\contact\Functional\Rest core/modules/contact/tests/src/Functional/Rest/MessageResourceTestBase.php 6
Messages class Drupal\views\Plugin\views\area core/modules/views/src/Plugin/views/area/Messages.php Provides an area for messages. 1
MessagesBlockPluginInterface interface Drupal\Core\Block core/lib/Drupal/Core/Block/MessagesBlockPluginInterface.php The interface for "messages" (#type => status_messages) blocks. 1 2
MessagesTest class Drupal\Tests\views\Unit\Plugin\area core/modules/views/tests/src/Unit/Plugin/area/MessagesTest.php @coversDefaultClass \Drupal\views\Plugin\views\area\Messages[[api-linebreak]] @group views
MessageTest class Drupal\KernelTests\Core\Theme core/tests/Drupal/KernelTests/Core/Theme/MessageTest.php Tests built-in message theme functions.
MessageTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/MessageTest.php JSON:API integration test for the "Message" content entity type.
MessageViewBuilder class Drupal\contact core/modules/contact/src/MessageViewBuilder.php Render controller for contact messages.
MessageXmlAnonTest class Drupal\Tests\contact\Functional\Rest core/modules/contact/tests/src/Functional/Rest/MessageXmlAnonTest.php @group rest
MessageXmlBasicAuthTest class Drupal\Tests\contact\Functional\Rest core/modules/contact/tests/src/Functional/Rest/MessageXmlBasicAuthTest.php @group rest
MessageXmlCookieTest class Drupal\Tests\contact\Functional\Rest core/modules/contact/tests/src/Functional/Rest/MessageXmlCookieTest.php @group rest
Messenger class Drupal\Core\Messenger core/lib/Drupal/Core/Messenger/Messenger.php The messenger service. 2
MessengerInterface interface Drupal\Core\Messenger core/lib/Drupal/Core/Messenger/MessengerInterface.php Stores runtime messages sent out to individual users on the page. 1 56
MessengerTest class Drupal\KernelTests\Core\Messenger core/tests/Drupal/KernelTests/Core/Messenger/MessengerTest.php @group Messenger @coversDefaultClass \Drupal\Core\Messenger\Messenger[[api-linebreak]]
MessengerTrait trait Drupal\Core\Messenger core/lib/Drupal/Core/Messenger/MessengerTrait.php Provides a trait for the messenger service. 8
MetadataBag class Drupal\Core\Session core/lib/Drupal/Core/Session/MetadataBag.php Provides a container for application specific session metadata. 2 2
MetadataBagTest class Drupal\Tests\Core\Session core/tests/Drupal/Tests/Core/Session/MetadataBagTest.php @coversDefaultClass \Drupal\Core\Session\MetadataBag[[api-linebreak]] @group Session
MetadataBubblingUrlGenerator class Drupal\Core\Render core/lib/Drupal/Core/Render/MetadataBubblingUrlGenerator.php Decorator for the URL generator, which bubbles bubbleable URL metadata. 3 2
MetadataBubblingUrlGeneratorTest class Drupal\Tests\Core\Render core/tests/Drupal/Tests/Core/Render/MetadataBubblingUrlGeneratorTest.php Confirm that the MetadataBubblingUrlGenerator is functioning properly.
MetapackageUpdateTest class Drupal\Tests\Composer\Generator core/tests/Drupal/Tests/Composer/Generator/MetapackageUpdateTest.php Test to see if the metapackages are up-to-date with the root composer.lock.
MethodFilter class Drupal\Core\Routing core/lib/Drupal/Core/Routing/MethodFilter.php Filters routes based on the HTTP method. 1 2
MethodFilterTest class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/MethodFilterTest.php @coversDefaultClass \Drupal\Core\Routing\MethodFilter[[api-linebreak]] @group Routing
MethodRequires class Drupal\BuildTests\Framework\Tests core/tests/Drupal/BuildTests/Framework/Tests/ExternalCommandRequirementTest.php
MigrateAccessCheck class Drupal\migrate_drupal_ui core/modules/migrate_drupal_ui/src/MigrateAccessCheck.php Checks access for migrate_drupal_ui routes.
MigrateAccessTest class Drupal\Tests\migrate_drupal_ui\Functional core/modules/migrate_drupal_ui/tests/src/Functional/MigrateAccessTest.php Tests that only user 1 can access the migrate UI.
MigrateActionConfigsTest class Drupal\Tests\system\Kernel\Migrate\d6 core/modules/system/tests/src/Kernel/Migrate/d6/MigrateActionConfigsTest.php Upgrade variables to null.
MigrateActionConfigsTest class Drupal\Tests\system\Kernel\Migrate\d7 core/modules/system/tests/src/Kernel/Migrate/d7/MigrateActionConfigsTest.php Upgrade variables to null.
MigrateActionsTest class Drupal\Tests\system\Kernel\Migrate\d6 core/modules/system/tests/src/Kernel/Migrate/d6/MigrateActionsTest.php Tests migration of action items.
MigrateActionsTest class Drupal\Tests\system\Kernel\Migrate\d7 core/modules/system/tests/src/Kernel/Migrate/d7/MigrateActionsTest.php Tests migration of action items.
MigrateActionsTest class Drupal\Tests\action\Kernel\Migrate\d6 core/modules/action/tests/src/Kernel/Migrate/d6/MigrateActionsTest.php Tests migration of action items.
MigrateActionsTest class Drupal\Tests\action\Kernel\Migrate\d7 core/modules/action/tests/src/Kernel/Migrate/d7/MigrateActionsTest.php Tests migration of action items.
MigrateBlockContentBodyFieldTest class Drupal\Tests\block_content\Kernel\Migrate core/modules/block_content/tests/src/Kernel/Migrate/MigrateBlockContentBodyFieldTest.php Attaches a body field to the block type.
MigrateBlockContentEntityDisplayTest class Drupal\Tests\block_content\Kernel\Migrate core/modules/block_content/tests/src/Kernel/Migrate/MigrateBlockContentEntityDisplayTest.php Tests migration of block content body field display configuration.
MigrateBlockContentEntityFormDisplayTest class Drupal\Tests\block_content\Kernel\Migrate core/modules/block_content/tests/src/Kernel/Migrate/MigrateBlockContentEntityFormDisplayTest.php Tests migration of block content body field form display configuration.
MigrateBlockContentStubTest class Drupal\Tests\block_content\Kernel\Migrate core/modules/block_content/tests/src/Kernel/Migrate/MigrateBlockContentStubTest.php Test stub creation for block_content entities.
MigrateBlockContentTest class Drupal\Tests\block_content\Kernel\Migrate\d6 core/modules/block_content/tests/src/Kernel/Migrate/d6/MigrateBlockContentTest.php Upgrade content blocks.
MigrateBlockContentTranslationTest class Drupal\Tests\block\Kernel\Migrate\d6 core/modules/block/tests/src/Kernel/Migrate/d6/MigrateBlockContentTranslationTest.php Tests migration of i18n block translations.
MigrateBlockContentTranslationTest class Drupal\Tests\block\Kernel\Migrate\d7 core/modules/block/tests/src/Kernel/Migrate/d7/MigrateBlockContentTranslationTest.php Tests migration of i18n block translations.
MigrateBlockContentTypeTest class Drupal\Tests\block_content\Kernel\Migrate core/modules/block_content/tests/src/Kernel/Migrate/MigrateBlockContentTypeTest.php Tests migration of the basic block content type.
MigrateBlockedIpsTest class Drupal\Tests\ban\Kernel\Migrate\d7 core/modules/ban/tests/src/Kernel/Migrate/d7/MigrateBlockedIpsTest.php Migrate blocked IPs.
MigrateBlockNoBlockContentTest class Drupal\Tests\block\Kernel\Migrate\d7 core/modules/block/tests/src/Kernel/Migrate/d7/MigrateBlockNoBlockContentTest.php Tests the migration of blocks without Block Content installed.

Other projects

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