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
HtmxUtilitiesTest class Drupal\Tests\Core\Htmx core/tests/Drupal/Tests/Core/Htmx/HtmxUtilitiesTest.php Test all Htmx public utility methods.
HtRouterTest class Drupal\BuildTests\Framework\Tests core/tests/Drupal/BuildTests/Framework/Tests/HtRouterTest.php Tests Drupal\BuildTests\Framework\BuildTestBase.
Http4xxController class Drupal\system\Controller core/modules/system/src/Controller/Http4xxController.php Controller for default HTTP 4xx responses.
HttpExceptionNormalizer class Drupal\jsonapi\Normalizer core/modules/jsonapi/src/Normalizer/HttpExceptionNormalizer.php Normalizes an HttpException in compliance with the JSON:API specification. 2 4 2
HttpExceptionNormalizerTest class Drupal\Tests\jsonapi\Unit\Normalizer core/modules/jsonapi/tests/src/Unit/Normalizer/HttpExceptionNormalizerTest.php Tests Drupal\jsonapi\Normalizer\HttpExceptionNormalizer.
HttpExceptionNormalizerValue class Drupal\jsonapi\Normalizer\Value core/modules/jsonapi/src/Normalizer/Value/HttpExceptionNormalizerValue.php Helps normalize exceptions in compliance with the JSON:API spec. 2
HttpExceptionSubscriberBase abstract class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/HttpExceptionSubscriberBase.php Utility base class for exception subscribers. 6 2
HttpKernelUiHelperTrait trait Drupal\Tests core/tests/Drupal/Tests/HttpKernelUiHelperTrait.php Provides UI helper methods using the HTTP kernel to make requests. 10
HttpResponseDebugCacheabilityHeadersTest class Drupal\KernelTests\Core\EventSubscriber core/tests/Drupal/KernelTests/Core/EventSubscriber/HttpResponseDebugCacheabilityHeadersTest.php Tests that debug cacheability header lines do not exceed Apache limit.
HTTPStatusCode class Drupal\views\Plugin\views\area core/modules/views/src/Plugin/views/area/HTTPStatusCode.php Alter the HTTP response status code used by the view.
HWLDFWordAccumulator class Drupal\Component\Diff\Engine core/lib/Drupal/Component/Diff/Engine/HWLDFWordAccumulator.php @todo document @private @subpackage DifferenceEngine 2
HWLDFWordAccumulatorTest class Drupal\Tests\Component\Diff\Engine core/tests/Drupal/Tests/Component/Diff/Engine/HWLDFWordAccumulatorTest.php Test HWLDFWordAccumulator.
I18nQueryTrait trait Drupal\migrate_drupal\Plugin\migrate\source core/modules/migrate_drupal/src/Plugin/migrate/source/I18nQueryTrait.php Gets an i18n translation from the source database. 4
I18nQueryTraitTest class Drupal\Tests\migrate_drupal\Kernel core/modules/migrate_drupal/tests/src/Kernel/I18nQueryTraitTest.php Tests instantiating migrate source plugins using I18nQueryTrait.
Icon class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Icon.php Provides a render element to display an icon. 1
IconBuilderInterface interface Drupal\Core\Layout\Icon core/lib/Drupal/Core/Layout/Icon/IconBuilderInterface.php Provides an interface for building layout icons. 1
IconBuilderTest class Drupal\KernelTests\Core\Layout core/tests/Drupal/KernelTests/Core/Layout/IconBuilderTest.php Tests Drupal\Core\Layout\Icon\SvgIconBuilder.
IconCollector class Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconCollector.php A CacheCollector implementation for building icons info. 2
IconDefinition class Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconDefinition.php Handle an icon definition. 11
IconDefinitionInterface interface Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconDefinitionInterface.php Interface for icon definition. 1 7
IconDefinitionInvalidDataException class Drupal\Core\Theme\Icon\Exception core/lib/Drupal/Core/Theme/Icon/Exception/IconDefinitionInvalidDataException.php Raised when icon data is invalid. 2
IconDefinitionTest class Drupal\Tests\Core\Theme\Icon core/tests/Drupal/Tests/Core/Theme/Icon/IconDefinitionTest.php Tests Drupal\Core\Theme\Icon\IconDefinition.
IconExtractor class Drupal\Core\Theme\Icon\Attribute core/lib/Drupal/Core/Theme/Icon/Attribute/IconExtractor.php The icon_extractor attribute. 7
IconExtractorBase abstract class Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconExtractorBase.php Base class for icon extractor plugins. 2 1
IconExtractorInterface interface Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconExtractorInterface.php Interface for icon_extractor plugins. 2
IconExtractorPluginManager class Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconExtractorPluginManager.php IconExtractor plugin manager. 2 2
IconExtractorSettingsForm class Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconExtractorSettingsForm.php Handle icon extractor settings form conversion from YAML to Drupal Form API. 1
IconExtractorSettingsFormTest class Drupal\Tests\Core\Theme\Icon core/tests/Drupal/Tests/Core/Theme/Icon/IconExtractorSettingsFormTest.php Tests Drupal\Core\Theme\Icon\IconExtractorSettingsForm.
IconExtractorTest class Drupal\Tests\Core\Theme\Icon core/tests/Drupal/Tests/Core/Theme/Icon/IconExtractorTest.php Tests Drupal\Core\Theme\Icon\Attribute\IconExtractor.
IconExtractorWithFinder abstract class Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconExtractorWithFinder.php Base class for icon_extractor plugins. 4 4
IconExtractorWithFinderInterface interface Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconExtractorWithFinderInterface.php Interface for icon_extractor plugins. 1
IconFinder class Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconFinder.php Icon finder to discover files under specific paths or URLs. 5
IconFinderInterface interface Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconFinderInterface.php Interface for icon finder. 1
IconFinderTest class Drupal\Tests\Core\Theme\Icon core/tests/Drupal/Tests/Core/Theme/Icon/IconFinderTest.php Tests Drupal\Core\Theme\Icon\IconFinder.
IconMimeTypes final class Drupal\file core/modules/file/src/IconMimeTypes.php A utility class for working with MIME types. 1
IconPackConfigErrorException class Drupal\Core\Theme\Icon\Exception core/lib/Drupal/Core/Theme/Icon/Exception/IconPackConfigErrorException.php Raised when we have an icon pack error. 6
IconPackExtractorForm class Drupal\Core\Theme\Icon core/lib/Drupal/Core/Theme/Icon/IconPackExtractorForm.php The icon pack extractor form plugin. 6
IconPackExtractorFormTest class Drupal\Tests\Core\Theme\Icon core/tests/Drupal/Tests/Core/Theme/Icon/IconPackExtractorFormTest.php Tests Drupal\Core\Theme\Icon\IconPackExtractorForm.
IconPackManager class Drupal\Core\Theme\Icon\Plugin core/lib/Drupal/Core/Theme/Icon/Plugin/IconPackManager.php Defines an icon pack plugin manager to deal with icons. 2 2
IconPackManagerInterface interface Drupal\Core\Theme\Icon\Plugin core/lib/Drupal/Core/Theme/Icon/Plugin/IconPackManagerInterface.php Interface for icon pack manager. 1 2
IconPackManagerKernelTest class Drupal\KernelTests\Core\Theme\Icon core/tests/Drupal/KernelTests/Core/Theme/Icon/IconPackManagerKernelTest.php Tests values are from test module icon_test.
IconPackManagerTest class Drupal\Tests\Core\Theme\Icon core/tests/Drupal/Tests/Core/Theme/Icon/IconPackManagerTest.php Tests Drupal\Core\Theme\Icon\Plugin\IconPackManager.
IconsTwigExtension final class Drupal\Core\Template core/lib/Drupal/Core/Template/IconsTwigExtension.php Twig extension for icon. 1
IconsTwigExtensionTest class Drupal\Tests\Core\Theme\Icon core/tests/Drupal/Tests/Core/Theme/Icon/IconsTwigExtensionTest.php Tests Drupal\Core\Template\IconsTwigExtension.
IconTest class Drupal\Tests\Core\Theme\Icon core/tests/Drupal/Tests/Core/Theme/Icon/IconTest.php Tests Drupal\Core\Render\Element\Icon.
IconTestTrait trait Drupal\Tests\Core\Theme\Icon core/tests/Drupal/Tests/Core/Theme/Icon/IconTestTrait.php Provides methods to generate icons for tests. 3
IdAuditor class Drupal\migrate\Audit core/modules/migrate/src/Audit/IdAuditor.php Audits migrations that create content entities in the destination system. 3
IdConflictForm class Drupal\migrate_drupal_ui\Form core/modules/migrate_drupal_ui/src/Form/IdConflictForm.php Migrate Upgrade Id Conflict form. 1
IdConflictTest class Drupal\Tests\migrate_drupal_ui\Functional\d6 core/modules/migrate_drupal_ui/tests/src/Functional/d6/IdConflictTest.php Tests Drupal 6 Id Conflict page.
IdConflictTest class Drupal\Tests\migrate_drupal_ui\Functional\d7 core/modules/migrate_drupal_ui/tests/src/Functional/d7/IdConflictTest.php Tests Drupal 7 Id Conflict page.

Other projects

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