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
ShortcutJsonAnonTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutJsonAnonTest.php	Tests Shortcut Json Anon.
ShortcutJsonBasicAuthTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutJsonBasicAuthTest.php	Tests Shortcut Json Basic Auth.
ShortcutJsonCookieTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutJsonCookieTest.php	Tests Shortcut Json Cookie.
ShortcutLazyBuilder		final class	Drupal\navigation	core/modules/navigation/src/ShortcutLazyBuilder.php	Lazy Builders for Navigation shortcuts links.
ShortcutLazyBuilders		class	Drupal\shortcut	core/modules/shortcut/src/ShortcutLazyBuilders.php	Lazy builders for the shortcut module.		1	2
ShortcutLinksTest		class	Drupal\Tests\shortcut\Functional	core/modules/shortcut/tests/src/Functional/ShortcutLinksTest.php	Create, view, edit, delete, and change shortcut links.
ShortcutLinkTarget		class	Drupal\shortcut\Entity	core/modules/shortcut/src/Entity/ShortcutLinkTarget.php	Provides a Shortcut link target handler.
ShortcutLocalTasksTest		class	Drupal\Tests\shortcut\Unit\Menu	core/modules/shortcut/tests/src/Unit/Menu/ShortcutLocalTasksTest.php	Tests existence of shortcut local tasks.
ShortcutResourceTestBase		abstract class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutResourceTestBase.php	Resource test base for Shortcut entity.	6
ShortcutsBlock		class	Drupal\shortcut\Plugin\Block	core/modules/shortcut/src/Plugin/Block/ShortcutsBlock.php	Provides a 'Shortcut' block.
ShortcutSet		class	Drupal\shortcut\Entity	core/modules/shortcut/src/Entity/ShortcutSet.php	Defines the Shortcut set configuration entity.		17
ShortcutSet		class	Drupal\shortcut\Plugin\migrate\source\d7	core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSet.php	Drupal 7 shortcut_set source from database.		1
ShortcutSetAccessControlHandler		class	Drupal\shortcut	core/modules/shortcut/src/ShortcutSetAccessControlHandler.php	Defines the access control handler for the shortcut set entity type.		1
ShortcutSetController		class	Drupal\shortcut\Controller	core/modules/shortcut/src/Controller/ShortcutSetController.php	Builds the page for administering shortcut sets.
ShortcutSetDeleteForm		class	Drupal\shortcut\Form	core/modules/shortcut/src/Form/ShortcutSetDeleteForm.php	Builds the shortcut set deletion form.		1
ShortcutSetForm		class	Drupal\shortcut	core/modules/shortcut/src/ShortcutSetForm.php	Form handler for the shortcut set entity edit forms.		1
ShortcutSetInterface		interface	Drupal\shortcut	core/modules/shortcut/src/ShortcutSetInterface.php	Provides an interface defining a shortcut set entity.	1	7
ShortcutSetJsonAnonTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutSetJsonAnonTest.php	Tests Shortcut Set Json Anon.
ShortcutSetJsonBasicAuthTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutSetJsonBasicAuthTest.php	Tests Shortcut Set Json Basic Auth.
ShortcutSetJsonCookieTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutSetJsonCookieTest.php	Tests Shortcut Set Json Cookie.
ShortcutSetListBuilder		class	Drupal\shortcut	core/modules/shortcut/src/ShortcutSetListBuilder.php	Defines a class to build a listing of shortcut set entities.		1
ShortcutSetResourceTestBase		abstract class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutSetResourceTestBase.php	Resource test base for ShortcutSet entity.	6
ShortcutSetsTest		class	Drupal\Tests\shortcut\Functional	core/modules/shortcut/tests/src/Functional/ShortcutSetsTest.php	Create, view, edit, delete, and change shortcut sets.
ShortcutSetStorage		class	Drupal\shortcut	core/modules/shortcut/src/ShortcutSetStorage.php	Defines a storage for shortcut_set entities.		1
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\Functional\Jsonapi	core/modules/shortcut/tests/src/Functional/Jsonapi/ShortcutSetTest.php	JSON:API integration test for the "ShortcutSet" config entity type.
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.		1
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	Tests Shortcut Set Xml Anon.
ShortcutSetXmlBasicAuthTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutSetXmlBasicAuthTest.php	Tests Shortcut Set Xml Basic Auth.
ShortcutSetXmlCookieTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutSetXmlCookieTest.php	Tests Shortcut Set Xml Cookie.
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.
ShortcutTest		class	Drupal\Tests\shortcut\Functional\Jsonapi	core/modules/shortcut/tests/src/Functional/Jsonapi/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
ShortcutThemeHooks		class	Drupal\shortcut\Hook	core/modules/shortcut/src/Hook/ShortcutThemeHooks.php	Hook implementations for shortcut.
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	Tests Shortcut Xml Anon.
ShortcutXmlBasicAuthTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutXmlBasicAuthTest.php	Tests Shortcut Xml Basic Auth.
ShortcutXmlCookieTest		class	Drupal\Tests\shortcut\Functional\Rest	core/modules/shortcut/tests/src/Functional/Rest/ShortcutXmlCookieTest.php	Tests Shortcut Xml Cookie.
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
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

Other projects

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