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
ShortcutSetStorage class Drupal\shortcut core/modules/shortcut/src/ShortcutSetStorage.php Defines a storage for shortcut_set entities.
ShortcutSetStorageInterface interface Drupal\shortcut core/modules/shortcut/src/ShortcutSetStorageInterface.php Defines an interface for shortcut_set entity storage classes. 1 3
ShortcutSetTest class Drupal\Tests\shortcut\Kernel\Plugin\migrate\source\d7 core/modules/shortcut/tests/src/Kernel/Plugin/migrate/source/d7/ShortcutSetTest.php Tests D7 ShortcutSet source plugin.
ShortcutSetTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/ShortcutSetTest.php JSON:API integration test for the "ShortcutSet" config entity type.
ShortcutSetUsers class Drupal\shortcut\Plugin\migrate\destination core/modules/shortcut/src/Plugin/migrate/destination/ShortcutSetUsers.php Migration destination for shortcut_set_users. 1
ShortcutSetUsers class Drupal\shortcut\Plugin\migrate\source\d7 core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php Drupal 7 shortcut_set_users source from database.
ShortcutSetUsersTest class Drupal\Tests\shortcut\Kernel\Plugin\migrate\source\d7 core/modules/shortcut/tests/src/Kernel/Plugin/migrate/source/d7/ShortcutSetUsersTest.php Tests D7 ShortcutSetUsers source plugin.
ShortcutSetValidationTest class Drupal\Tests\shortcut\Kernel core/modules/shortcut/tests/src/Kernel/ShortcutSetValidationTest.php Tests validation of shortcut_set entities.
ShortcutSetXmlAnonTest class Drupal\Tests\shortcut\Functional\Rest core/modules/shortcut/tests/src/Functional/Rest/ShortcutSetXmlAnonTest.php @group rest
ShortcutSetXmlBasicAuthTest class Drupal\Tests\shortcut\Functional\Rest core/modules/shortcut/tests/src/Functional/Rest/ShortcutSetXmlBasicAuthTest.php @group rest
ShortcutSetXmlCookieTest class Drupal\Tests\shortcut\Functional\Rest core/modules/shortcut/tests/src/Functional/Rest/ShortcutSetXmlCookieTest.php @group rest
ShortcutTest class Drupal\Tests\shortcut\Kernel\Plugin\migrate\source\d7 core/modules/shortcut/tests/src/Kernel/Plugin/migrate/source/d7/ShortcutTest.php Tests D7 Shortcut source plugin.
ShortcutTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/ShortcutTest.php JSON:API integration test for the "Shortcut" content entity type.
ShortcutTestBase abstract class Drupal\Tests\shortcut\Functional core/modules/shortcut/tests/src/Functional/ShortcutTestBase.php Defines base class for shortcut test cases. 2
ShortcutTranslationUITest class Drupal\Tests\shortcut\Functional core/modules/shortcut/tests/src/Functional/ShortcutTranslationUITest.php Tests the shortcut translation UI.
ShortcutXmlAnonTest class Drupal\Tests\shortcut\Functional\Rest core/modules/shortcut/tests/src/Functional/Rest/ShortcutXmlAnonTest.php @group rest
ShortcutXmlBasicAuthTest class Drupal\Tests\shortcut\Functional\Rest core/modules/shortcut/tests/src/Functional/Rest/ShortcutXmlBasicAuthTest.php @group rest
ShortcutXmlCookieTest class Drupal\Tests\shortcut\Functional\Rest core/modules/shortcut/tests/src/Functional/Rest/ShortcutXmlCookieTest.php @group rest
ShowButtonsCommand class Drupal\views\Ajax core/modules/views/src/Ajax/ShowButtonsCommand.php Provides an AJAX command for showing the save and cancel buttons. 1
ShutdownFunctionsTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/ShutdownFunctionsTest.php Functional tests shutdown functions.
ShutdownFunctionTest class Drupal\KernelTests\Core\Bootstrap core/tests/Drupal/KernelTests/Core/Bootstrap/ShutdownFunctionTest.php Tests.
SimpleAnnotationReader final class Drupal\Component\Annotation\Doctrine core/lib/Drupal/Component/Annotation/Doctrine/SimpleAnnotationReader.php Simple Annotation Reader. 3
SimpleConfigLangcodeTest class Drupal\Tests\system\Functional\Update core/modules/system/tests/src/Functional/Update/SimpleConfigLangcodeTest.php @group system @group Update @covers system_post_update_add_langcode_to_all_translatable_config[[api-linebreak]]
SimpleConfigSectionListTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/SimpleConfigSectionListTest.php Tests the test implementation of section storage.
SimpleConfigSectionStorage class Drupal\layout_builder_test\Plugin\SectionStorage core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/SectionStorage/SimpleConfigSectionStorage.php Provides section storage utilizing simple config. 1
SimpleConfigUpdate final class Drupal\Core\Config\Action\Plugin\ConfigAction core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/SimpleConfigUpdate.php @internal This API is experimental.
SimpleConfigValidationTest class Drupal\KernelTests\Core\Config core/tests/Drupal/KernelTests/Core/Config/SimpleConfigValidationTest.php Tests validation of certain elements common to all config.
SimplePageVariant class Drupal\Core\Render\Plugin\DisplayVariant core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php Provides a page display variant that simply renders the main content.
SimpletestTestRunResultsStorage class Drupal\Core\Test core/lib/Drupal/Core/Test/SimpletestTestRunResultsStorage.php Implements a test run results storage compatible with legacy Simpletest. 3
SimpletestTestRunResultsStorageTest class Drupal\KernelTests\Core\Test core/tests/Drupal/KernelTests/Core/Test/SimpletestTestRunResultsStorageTest.php @coversDefaultClass \Drupal\Core\Test\SimpletestTestRunResultsStorage[[api-linebreak]] @group Test
SingleFlushStrategy class Drupal\Core\Render\Placeholder core/lib/Drupal/Core/Render/Placeholder/SingleFlushStrategy.php Defines the 'single_flush' placeholder strategy. 2
SingleInternalPropertyTestFieldItem class Drupal\entity_test\Plugin\Field\FieldType core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/SingleInternalPropertyTestFieldItem.php Defines the 'Single Internal Property' entity test field type.
SingleVisibleProfileTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/SingleVisibleProfileTest.php Tests distribution profile support.
SiteCacheContext class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/SiteCacheContext.php Defines the SiteCacheContext service, for "per site" caching. 2
SiteConfigureForm class Drupal\Core\Installer\Form core/lib/Drupal/Core/Installer/Form/SiteConfigureForm.php Provides the site configuration form.
SiteInformationForm class Drupal\system\Form core/modules/system/src/Form/SiteInformationForm.php Configure site information settings for this site. 1 1
SiteMaintenanceModeForm class Drupal\system\Form core/modules/system/src/Form/SiteMaintenanceModeForm.php Configure maintenance settings for this site. 1
SiteMaintenanceTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/SiteMaintenanceTest.php Tests access to site while in maintenance mode.
SiteNameTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/SiteNameTest.php Tests that the site name can be set during a non-interactive installation.
SitesDirectoryHardeningTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/SitesDirectoryHardeningTest.php Tests Drupal permissions hardening of /sites subdirectories.
SiteSettingsForm class Drupal\Core\Installer\Form core/lib/Drupal/Core/Installer/Form/SiteSettingsForm.php Provides a form to configure and rewrite settings.php. 1 2
SiteSettingsFormTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/SiteSettingsFormTest.php Tests the extension of the site settings form.
SkipOnEmpty class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/SkipOnEmpty.php Skips processing the current row when the input value is empty. 1
SkipOnEmptyTest class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/SkipOnEmptyTest.php Tests the skip on empty process plugin.
SkipOp class Drupal\Composer\Plugin\Scaffold\Operations composer/Plugin/Scaffold/Operations/SkipOp.php Scaffold operation to skip a scaffold file (do nothing). 2
SkipOpTest class Drupal\Tests\Composer\Plugin\Scaffold\Integration core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Integration/SkipOpTest.php @coversDefaultClass \Drupal\Composer\Plugin\Scaffold\Operations\SkipOp[[api-linebreak]]
SkipRowIfNotSet class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/SkipRowIfNotSet.php Skips processing the current row when a source value is not set. 1
SkipRowIfNotSetTest class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/SkipRowIfNotSetTest.php Tests the skip row if not set process plugin.
SmartDefaultSettings final class Drupal\ckeditor5 core/modules/ckeditor5/src/SmartDefaultSettings.php Generates CKEditor 5 settings for existing text editors/formats. 2 2
SmartDefaultSettingsTest class Drupal\Tests\ckeditor5\Unit core/modules/ckeditor5/tests/src/Unit/SmartDefaultSettingsTest.php @coversDefaultClass \Drupal\ckeditor5\SmartDefaultSettings[[api-linebreak]] @group ckeditor5

Other projects

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