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
ThemeEngineInterface interface Drupal\Core\Theme core/lib/Drupal/Core/Theme/ThemeEngineInterface.php Defines an interface for a theme engine. 2 2
ThemeEngineTest class Drupal\Tests\system\Kernel\Theme core/modules/system/tests/src/Kernel/Theme/ThemeEngineTest.php Tests theme engine functionality.
ThemeExperimentalConfirmForm class Drupal\system\Form core/modules/system/src/Form/ThemeExperimentalConfirmForm.php Builds a confirmation form for enabling experimental themes. 1
ThemeExtensionList class Drupal\Core\Extension core/lib/Drupal/Core/Extension/ThemeExtensionList.php Provides a list of available themes. 2 27 2
ThemeExtensionListTest class Drupal\KernelTests\Core\Extension core/tests/Drupal/KernelTests/Core/Extension/ThemeExtensionListTest.php Tests Drupal\Core\Extension\ThemeExtensionList.
ThemeExtensionListTest class Drupal\Tests\Core\Extension core/tests/Drupal/Tests/Core/Extension/ThemeExtensionListTest.php Tests Drupal\Core\Extension\ThemeExtensionList.
ThemeHandler class Drupal\Core\Extension core/lib/Drupal/Core/Extension/ThemeHandler.php Default theme handler using the config system to store installation statuses. 1 1 2
ThemeHandlerInterface interface Drupal\Core\Extension core/lib/Drupal/Core/Extension/ThemeHandlerInterface.php Manages the list of available themes. 1 60
ThemeHandlerTest class Drupal\Tests\Core\Extension core/tests/Drupal/Tests/Core/Extension/ThemeHandlerTest.php Tests Drupal\Core\Extension\ThemeHandler.
ThemeHookCollectorPass class Drupal\Core\Hook core/lib/Drupal/Core/Hook/ThemeHookCollectorPass.php Collects and registers hook implementations. 2
ThemeHookCollectorPassTest class Drupal\KernelTests\Core\Hook core/tests/Drupal/KernelTests/Core/Hook/ThemeHookCollectorPassTest.php Tests Drupal\Core\Hook\ThemeHookCollectorPass.
ThemeHooks class Drupal\admin\Hook core/themes/admin/src/Hook/ThemeHooks.php Provides theme related hook implementations.
ThemeHooks class Drupal\default_admin\Hook core/themes/default_admin/src/Hook/ThemeHooks.php Provides theme related hook implementations.
ThemeHookTest class Drupal\Tests\system\Kernel\Theme core/modules/system/tests/src/Kernel/Theme/ThemeHookTest.php Tests low-level theme functions.
ThemeInfoTest class Drupal\Tests\system\Functional\Theme core/modules/system/tests/src/Functional/Theme/ThemeInfoTest.php Tests processing of theme .info.yml properties.
ThemeInitialization class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ThemeInitialization.php Provides the theme initialization logic. 2
ThemeInitializationInterface interface Drupal\Core\Theme core/lib/Drupal/Core/Theme/ThemeInitializationInterface.php Defines an interface which contain theme initialization logic. 1 4
ThemeInstallController class Drupal\nightwatch_theme_install_utility\Controller core/modules/system/tests/modules/nightwatch_theme_install_utility/src/Controller/ThemeInstallController.php Provides an easier way for Nightwatch tests to install themes.
ThemeInstaller class Drupal\Core\Extension core/lib/Drupal/Core/Extension/ThemeInstaller.php Manages theme installation/uninstallation. 2
ThemeInstallerInterface interface Drupal\Core\Extension core/lib/Drupal/Core/Extension/ThemeInstallerInterface.php Manages theme installation/uninstallation. 1 13
ThemeInstallerTest class Drupal\KernelTests\Core\Theme core/tests/Drupal/KernelTests/Core/Theme/ThemeInstallerTest.php Tests installing and uninstalling of themes.
ThemeLocalTask class Drupal\block\Plugin\Derivative core/modules/block/src/Plugin/Derivative/ThemeLocalTask.php Provides dynamic tabs based on active themes. 1
ThemeLocalTask class Drupal\system\Plugin\Derivative core/modules/system/src/Plugin/Derivative/ThemeLocalTask.php Provides dynamic tabs based on active themes. 1
ThemeManager class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ThemeManager.php Provides the default implementation of a theme manager. 2
ThemeManagerInterface interface Drupal\Core\Theme core/lib/Drupal/Core/Theme/ThemeManagerInterface.php Provides a high level access to the active theme and methods to use it. 1 44
ThemeNegotiator class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ThemeNegotiator.php Provides a class which determines the active theme of the page. 1 2
ThemeNegotiatorInterface interface Drupal\Core\Theme core/lib/Drupal/Core/Theme/ThemeNegotiatorInterface.php Defines an interface for classes which determine the active theme. 11 9
ThemeNegotiatorTest class Drupal\Tests\Core\Theme core/tests/Drupal/Tests/Core/Theme/ThemeNegotiatorTest.php Tests Drupal\Core\Theme\ThemeNegotiator.
ThemePageTestHooks class Drupal\theme_page_test\Hook core/modules/system/tests/modules/theme_page_test/src/Hook/ThemePageTestHooks.php Hook implementations for theme_page_test.
ThemePreprocess class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ThemePreprocess.php Preprocess for common/core theme templates. 2 2
ThemeProceduralTest class Drupal\Tests\system\Functional\Theme core/modules/system/tests/src/Functional/Theme/ThemeProceduralTest.php Tests low-level theme functions.
ThemeRegionTest class Drupal\KernelTests\Core\Theme core/tests/Drupal/KernelTests/Core/Theme/ThemeRegionTest.php Tests theme region listing.
ThemeRegionTestThemeHooks class Drupal\theme_region_test\Hook core/modules/system/tests/modules/theme_region_test/src/Hook/ThemeRegionTestThemeHooks.php Hook implementations for theme_region_test.
ThemeRegistry class Drupal\Core\Utility core/lib/Drupal/Core/Utility/ThemeRegistry.php Builds the run-time theme registry. 2
ThemeRegistryLoader class Drupal\Core\Template\Loader core/lib/Drupal/Core/Template/Loader/ThemeRegistryLoader.php Loads templates based on information from the Drupal theme registry. 1 2
ThemeRegistryLoaderTest class Drupal\Tests\Core\Template\Loader core/tests/Drupal/Tests/Core/Template/Loader/ThemeRegistryLoaderTest.php Tests Drupal\Core\Template\Loader\ThemeRegistryLoader.
ThemeSettings class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ThemeSettings.php Provides a configuration API wrapper for runtime merged theme settings. 1
ThemeSettings

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

 class Drupal\system\Plugin\migrate\destination\d7 core/modules/system/src/Plugin/migrate/destination/d7/ThemeSettings.php Persist theme settings to the config system. 1
ThemeSettings class Drupal\system\Plugin\migrate\source\d7 core/modules/system/src/Plugin/migrate/source/d7/ThemeSettings.php Drupal 7 theme settings source from database. 1
ThemeSettingsForm class Drupal\system\Form core/modules/system/src/Form/ThemeSettingsForm.php Displays theme configuration for entire site and individual themes. 1
ThemeSettingsFormTest class Drupal\Tests\system\FunctionalJavascript core/modules/system/tests/src/FunctionalJavascript/ThemeSettingsFormTest.php Tests that theme form settings works correctly.
ThemeSettingsProvider class Drupal\Core\Extension core/lib/Drupal/Core/Extension/ThemeSettingsProvider.php Default implementation of the theme settings provider service. 19
ThemeSettingsTest class Drupal\KernelTests\Core\Theme core/tests/Drupal/KernelTests/Core/Theme/ThemeSettingsTest.php Tests theme settings functionality.
ThemeSettingsTest class Drupal\Tests\system\Kernel\Plugin\migrate\source\d7 core/modules/system/tests/src/Kernel/Plugin/migrate/source/d7/ThemeSettingsTest.php Tests D7 theme settings source plugin.
ThemeStream final class Drupal\Core\StreamWrapper core/lib/Drupal/Core/StreamWrapper/ThemeStream.php Defines the read-only theme:// stream wrapper for theme files. 1 2
ThemeSuggestionHooks class Drupal\admin\Hook core/themes/admin/src/Hook/ThemeSuggestionHooks.php Provides theme suggestion hook implementations.
ThemeSuggestionHooks class Drupal\default_admin\Hook core/themes/default_admin/src/Hook/ThemeSuggestionHooks.php Provides theme suggestion hook implementations.
ThemeSuggestionsAlterTest class Drupal\Tests\system\Functional\Theme core/modules/system/tests/src/Functional/Theme/ThemeSuggestionsAlterTest.php Tests theme suggestion alter hooks.
ThemeSuggestionsTestHooks class Drupal\theme_suggestions_test\Hook core/modules/system/tests/modules/theme_suggestions_test/src/Hook/ThemeSuggestionsTestHooks.php Hook implementations for theme_suggestions_test.
ThemeTest class Drupal\Tests\system\Kernel\Theme core/modules/system/tests/src/Kernel/Theme/ThemeTest.php Tests low-level theme functions.

Other projects

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