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
HandlerTestTrait		trait	Drupal\Tests\views\Unit\Plugin	core/modules/views/tests/src/Unit/Plugin/HandlerTestTrait.php	Test trait to mock dependencies of a handler.		1
HeadersCacheContext		class	Drupal\Core\Cache\Context	core/lib/Drupal/Core/Cache/Context/HeadersCacheContext.php	Defines the HeadersCacheContext service, for "per header" caching.		1	2
HeadersCacheContextTest		class	Drupal\Tests\Core\Cache\Context	core/tests/Drupal/Tests/Core/Cache/Context/HeadersCacheContextTest.php	@coversDefaultClass \Drupal\Core\Cache\Context\HeadersCacheContext[[api-linebreak]] @group Cache
Heading		class	Drupal\ckeditor5\Plugin\CKEditor5Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Heading.php	CKEditor 5 Heading plugin.		6	1
HeadingPluginTest		class	Drupal\Tests\ckeditor5\Unit	core/modules/ckeditor5/tests/src/Unit/HeadingPluginTest.php	@coversDefaultClass \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Language[[api-linebreak]] @group ckeditor5 @internal
HelpBlock		class	Drupal\help\Plugin\Block	core/modules/help/src/Plugin/Block/HelpBlock.php	Provides a 'Help' block.
HelpBlockTest		class	Drupal\Tests\help\Functional	core/modules/help/tests/src/Functional/HelpBlockTest.php	Tests display of help block.
HelpBreadcrumbBuilder		class	Drupal\help	core/modules/help/src/HelpBreadcrumbBuilder.php	Provides a breadcrumb builder for help topic pages.	1	1	2
HelpBreadcrumbBuilder		class	Drupal\help_topics	core/modules/help_topics/src/HelpBreadcrumbBuilder.php	Provides a breadcrumb builder for help topic pages.
HelpController		class	Drupal\help\Controller	core/modules/help/src/Controller/HelpController.php	Controller routines for help routes.
HelpEmptyPageTest		class	Drupal\Tests\help\Kernel	core/modules/help/tests/src/Kernel/HelpEmptyPageTest.php	Tests the empty HTML page.
HelpPageOrderTest		class	Drupal\Tests\help\Functional	core/modules/help/tests/src/Functional/HelpPageOrderTest.php	Verify the order of the help page.	1
HelpPageReverseOrderTest		class	Drupal\Tests\help\Functional	core/modules/help/tests/src/Functional/HelpPageReverseOrderTest.php	Verify the order of the help page with an alter hook.
HelpPageTestController		class	Drupal\help_page_test	core/modules/help/tests/modules/help_page_test/src/HelpPageTestController.php	Provides controllers for testing the help block.
HelpSearch		class	Drupal\help\Plugin\Search	core/modules/help/src/Plugin/Search/HelpSearch.php	Handles searching for help using the Search module index.	1	2
HelpSearch		class	Drupal\help_topics\Plugin\Search	core/modules/help_topics/src/Plugin/Search/HelpSearch.php	Handles searching for help using the Search module index.
HelpSearchPluginTest		class	Drupal\Tests\help\Kernel	core/modules/help/tests/src/Kernel/HelpSearchPluginTest.php	Tests search plugin behaviors.
HelpSection		class	Drupal\help\Attribute	core/modules/help/src/Attribute/HelpSection.php	Defines a HelpSection attribute object for plugin discovery.		5
HelpSection		class	Drupal\help\Annotation	core/modules/help/src/Annotation/HelpSection.php	Defines a Plugin annotation object for help page section plugins.
HelpSectionManager		class	Drupal\help	core/modules/help/src/HelpSectionManager.php	Manages help page section plugins.	1	3	2
HelpSectionManager		class	Drupal\help_topics	core/modules/help_topics/src/HelpSectionManager.php	Decorates the Help Section plugin manager to provide help topic search.
HelpSectionPluginBase		abstract class	Drupal\help\Plugin\HelpSection	core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php	Provides a base class for help section plugins.	5	3
HelpSectionPluginInterface		interface	Drupal\help	core/modules/help/src/HelpSectionPluginInterface.php	Provides an interface for a plugin for a section of the /admin/help page.	1	1
HelpTest		class	Drupal\Tests\help\Functional	core/modules/help/tests/src/Functional/HelpTest.php	Verify help display and user access to help based on permissions.
HelpTestTwigExtension		class	Drupal\help_topics_twig_tester	core/modules/help/tests/modules/help_topics_twig_tester/src/HelpTestTwigExtension.php	Defines and registers Drupal Twig extensions for testing help topics.			2
HelpTestTwigNodeVisitor		class	Drupal\help_topics_twig_tester	core/modules/help/tests/modules/help_topics_twig_tester/src/HelpTestTwigNodeVisitor.php	Defines a Twig node visitor for testing help topics.		1
HelpTopicDiscovery		class	Drupal\help	core/modules/help/src/HelpTopicDiscovery.php	Discovers help topic plugins from Twig files in help_topics directories.	1	3
HelpTopicDiscovery		class	Drupal\help_topics	core/modules/help_topics/src/HelpTopicDiscovery.php	Discovers help topic plugins from Twig files in help_topics directories.
HelpTopicDiscoveryTest		class	Drupal\Tests\help\Unit	core/modules/help/tests/src/Unit/HelpTopicDiscoveryTest.php	@coversDefaultClass \Drupal\help\HelpTopicDiscovery[[api-linebreak]] @group help
HelpTopicPluginBase		abstract class	Drupal\help	core/modules/help/src/HelpTopicPluginBase.php	Base class for help topic plugins.	3	2
HelpTopicPluginBase		abstract class	Drupal\help_topics	core/modules/help_topics/src/HelpTopicPluginBase.php	Base class for help topic plugins.
HelpTopicPluginController		class	Drupal\help_topics\Controller	core/modules/help_topics/src/Controller/HelpTopicPluginController.php	Controller for help topic plugins.
HelpTopicPluginController		class	Drupal\help\Controller	core/modules/help/src/Controller/HelpTopicPluginController.php	Controller for help topic plugins.	1	1
HelpTopicPluginInterface		interface	Drupal\help_topics	core/modules/help_topics/src/HelpTopicPluginInterface.php	Defines an interface for help topic plugin classes.
HelpTopicPluginInterface		interface	Drupal\help	core/modules/help/src/HelpTopicPluginInterface.php	Defines an interface for help topic plugin classes.	2	2
HelpTopicPluginManager		class	Drupal\help	core/modules/help/src/HelpTopicPluginManager.php	Provides the default help_topic manager.	1	1	2
HelpTopicPluginManager		class	Drupal\help_topics	core/modules/help_topics/src/HelpTopicPluginManager.php	Provides the default help_topic manager.
HelpTopicPluginManagerInterface		interface	Drupal\help_topics	core/modules/help_topics/src/HelpTopicPluginManagerInterface.php	Defines an interface for managing help topics and storing their definitions.
HelpTopicPluginManagerInterface		interface	Drupal\help	core/modules/help/src/HelpTopicPluginManagerInterface.php	Defines an interface for managing help topics and storing their definitions.	2	3
HelpTopicSearchTest		class	Drupal\Tests\help\Functional	core/modules/help/tests/src/Functional/HelpTopicSearchTest.php	Verifies help topic search.
HelpTopicSection		class	Drupal\help\Plugin\HelpSection	core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php	Provides the help topics list section for the help page.	1	1
HelpTopicSection		class	Drupal\help_topics\Plugin\HelpSection	core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php	Provides the help topics list section for the help page.
HelpTopicsMerge		class	Drupal\Tests\help\Functional\Update	core/modules/help/tests/src/Functional/Update/HelpTopicsMerge.php	Tests merging help topics module when the module is not installed.
HelpTopicsSyntaxTest		class	Drupal\Tests\help\Functional	core/modules/help/tests/src/Functional/HelpTopicsSyntaxTest.php	Verifies that all core Help topics can be rendered and comply with standards.
HelpTopicsTestController		class	Drupal\help_topics_test\Controller	core/modules/help/tests/modules/help_topics_test/src/Controller/HelpTopicsTestController.php	Returns the response for help_topics_test routes.
HelpTopicsUninstall		class	Drupal\Tests\help\Functional\Update	core/modules/help/tests/src/Functional/Update/HelpTopicsUninstall.php	Tests merging help topics module when the module is enabled.
HelpTopicTest		class	Drupal\Tests\help\Functional	core/modules/help/tests/src/Functional/HelpTopicTest.php	Verifies help topic display and user access to help based on permissions.
HelpTopicTranslatedTestBase		abstract class	Drupal\Tests\help\Functional	core/modules/help/tests/src/Functional/HelpTopicTranslatedTestBase.php	Provides a base class for functional help topic tests that use translation.	2
HelpTopicTranslationTest		class	Drupal\Tests\help\Functional	core/modules/help/tests/src/Functional/HelpTopicTranslationTest.php	Verifies help topic translations.
HelpTopicTwig		class	Drupal\help	core/modules/help/src/HelpTopicTwig.php	Represents a help topic plugin whose definition comes from a Twig file.	1	3

Other projects

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