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
ShapeItemRequired		class	Drupal\entity_test\Plugin\Field\FieldType	core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/ShapeItemRequired.php	Defines the 'shape_required' field type.
ShapeItemTest		class	Drupal\Tests\field\Kernel	core/modules/field/tests/src/Kernel/ShapeItemTest.php	Tests the new entity API for the shape field type.
ShapeOnlyColorEditableWidget		class	Drupal\entity_test\Plugin\Field\FieldWidget	core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldWidget/ShapeOnlyColorEditableWidget.php	Plugin implementation of the 'shape_only_color_editable_widget' widget.
SharedEntityTestBundleClassA		class	Drupal\entity_test_bundle_class\Entity	core/modules/system/tests/modules/entity_test_bundle_class/src/Entity/SharedEntityTestBundleClassA.php	A bundle class that shares the same entity type as entity_test.		2
SharedEntityTestBundleClassB		class	Drupal\entity_test_bundle_class\Entity	core/modules/system/tests/modules/entity_test_bundle_class/src/Entity/SharedEntityTestBundleClassB.php	A bundle class that shares the same entity type as entity_test.		2
SharedTempStore		class	Drupal\Core\TempStore	core/lib/Drupal/Core/TempStore/SharedTempStore.php	Stores and retrieves temporary data for a given owner.		3
SharedTempStoreFactory		class	Drupal\Core\TempStore	core/lib/Drupal/Core/TempStore/SharedTempStoreFactory.php	Creates a shared temporary storage for a collection.		9	2
SharedTempStoreTest		class	Drupal\Tests\Core\TempStore	core/tests/Drupal/Tests/Core/TempStore/SharedTempStoreTest.php	Tests Drupal\Core\TempStore\SharedTempStore.
Shortcut		class	Drupal\shortcut\Entity	core/modules/shortcut/src/Entity/Shortcut.php	Defines the shortcut entity class.		12
Shortcut		class	Drupal\shortcut\Plugin\migrate\source\d7	core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php	Drupal 7 shortcut links source from database.		1
ShortcutAccessControlHandler		class	Drupal\shortcut	core/modules/shortcut/src/ShortcutAccessControlHandler.php	Defines the access control handler for the shortcut entity type.		1
ShortcutCacheTagsTest		class	Drupal\Tests\shortcut\Kernel	core/modules/shortcut/tests/src/Kernel/ShortcutCacheTagsTest.php	Tests the Shortcut entity's cache tags.
ShortcutCacheTagsTest		class	Drupal\Tests\shortcut\Functional	core/modules/shortcut/tests/src/Functional/ShortcutCacheTagsTest.php	Tests the Shortcut entity's cache tags.
ShortcutClaroIntegrationTest		class	Drupal\Tests\shortcut\Kernel	core/modules/shortcut/tests/src/Kernel/ShortcutClaroIntegrationTest.php	Tests shortcut_install() and shortcut_uninstall().
ShortcutController		class	Drupal\shortcut\Controller	core/modules/shortcut/src/Controller/ShortcutController.php	Provides route responses for taxonomy.module.
ShortcutDeleteForm		class	Drupal\shortcut\Form	core/modules/shortcut/src/Form/ShortcutDeleteForm.php	Builds the shortcut link deletion form.		1
ShortcutEntityLinksTest		class	Drupal\Tests\shortcut\Kernel	core/modules/shortcut/tests/src/Kernel/ShortcutEntityLinksTest.php	Tests the entity_links filter with shortcut entities.
ShortcutForm		class	Drupal\shortcut	core/modules/shortcut/src/ShortcutForm.php	Form handler for the shortcut entity forms.		1
ShortcutHooks		class	Drupal\shortcut\Hook	core/modules/shortcut/src/Hook/ShortcutHooks.php	Hook implementations for shortcut.
ShortcutInterface		interface	Drupal\shortcut	core/modules/shortcut/src/ShortcutInterface.php	Provides an interface defining a shortcut entity.	1	4
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

Other projects

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