Classes, traits, and interfaces - Drupal 11.1.x - Drupal Core

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
WorkspaceSafeFormTrait trait Drupal\Core\Entity\Form core/lib/Drupal/Core/Entity/Form/WorkspaceSafeFormTrait.php Provides helpers for checking whether objects in forms are workspace-safe. 2
WorkspaceSafeFormTrait trait Drupal\layout_builder\Form core/modules/layout_builder/src/Form/WorkspaceSafeFormTrait.php Provides a trait that marks Layout Builder forms as workspace-safe.
WorkspacesAliasManager class Drupal\workspaces core/modules/workspaces/src/WorkspacesAliasManager.php Decorates the path_alias.manager service for workspace-specific caching.
WorkspacesAliasRepository class Drupal\workspaces core/modules/workspaces/src/WorkspacesAliasRepository.php Provides workspace-specific path alias lookup queries.
WorkspaceSelection class Drupal\workspaces\Plugin\EntityReferenceSelection core/modules/workspaces/src/Plugin/EntityReferenceSelection/WorkspaceSelection.php Provides specific access control for the workspace entity type.
WorkspacesHooks class Drupal\workspaces\Hook core/modules/workspaces/src/Hook/WorkspacesHooks.php Hook implementations for workspaces.
WorkspacesHtmlEntityFormController class Drupal\workspaces\Controller core/modules/workspaces/src/Controller/WorkspacesHtmlEntityFormController.php Overrides the entity form controller service for workspaces operations. 2
WorkspacesLazyBuilders final class Drupal\workspaces core/modules/workspaces/src/WorkspacesLazyBuilders.php Defines a service for workspaces #lazy_builder callbacks. 2
WorkspacesMenuTreeStorage class Drupal\workspaces core/modules/workspaces/src/WorkspacesMenuTreeStorage.php Overrides the default menu storage to provide workspace-specific menu links. 2
WorkspacesServiceProvider class Drupal\workspaces core/modules/workspaces/src/WorkspacesServiceProvider.php Defines a service provider for the Workspaces module.
WorkspaceSubscriber class Drupal\content_moderation\EventSubscriber core/modules/content_moderation/src/EventSubscriber/WorkspaceSubscriber.php Checks whether a workspace is publishable, and prevents publishing if needed. 2
WorkspacesUiHooks class Drupal\workspaces_ui\Hook core/modules/workspaces_ui/src/Hook/WorkspacesUiHooks.php Hook implementations for the workspaces_ui module.
WorkspaceSwitcherBlock class Drupal\workspaces\Plugin\Block core/modules/workspaces/src/Plugin/Block/WorkspaceSwitcherBlock.php Provides a 'Workspace switcher' block.
WorkspaceSwitcherForm class Drupal\workspaces\Form core/modules/workspaces/src/Form/WorkspaceSwitcherForm.php Provides a form that activates a different workspace. 1
WorkspaceViewBuilder class Drupal\workspaces core/modules/workspaces/src/WorkspaceViewBuilder.php Provides a Workspace view builder. 1
WrappableOutputFormatterInterface interface Symfony\Component\Console\Formatter vendor/symfony/console/Formatter/WrappableOutputFormatterInterface.php Formatter interface for console output that supports word wrapping. 1 1
WrappedListener final class Symfony\Component\EventDispatcher\Debug vendor/symfony/event-dispatcher/Debug/WrappedListener.php @author Fabien Potencier <fabien@symfony.com> 1
Wrappers class GPBMetadata\Google\Protobuf vendor/google/protobuf/src/GPBMetadata/Google/Protobuf/Wrappers.php
WritableArrayRepository class Composer\Repository vendor/composer/composer/src/Composer/Repository/WritableArrayRepository.php Writable array repository. 2
WritableFileSystemValidator class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/WritableFileSystemValidator.php Checks that the file system is writable.
WritableMetricStreamInterface interface OpenTelemetry\SDK\Metrics\Stream vendor/open-telemetry/sdk/Metrics/Stream/WritableMetricStreamInterface.php @internal 1 1
WritableRepositoryInterface interface Composer\Repository vendor/composer/composer/src/Composer/Repository/WritableRepositoryInterface.php Writable repository interface. 2
WriteOperationFailedException final class SebastianBergmann\CodeCoverage\Driver vendor/phpunit/php-code-coverage/src/Exception/WriteOperationFailedException.php 5
Writer final class PHPUnit\Runner\Baseline vendor/phpunit/phpunit/src/Runner/Baseline/Writer.php @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit 1
WriteSafeSessionHandler class Drupal\Core\Session core/lib/Drupal/Core/Session/WriteSafeSessionHandler.php Wraps the session handler to prevent writes when not necessary or allowed.
WriteSafeSessionHandlerInterface interface Drupal\Core\Session core/lib/Drupal/Core/Session/WriteSafeSessionHandlerInterface.php Provides an interface for session handlers where writing can be disabled. 1
XdebugDriver final class SebastianBergmann\CodeCoverage\Driver vendor/phpunit/php-code-coverage/src/Driver/XdebugDriver.php @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
XdebugHandler class Composer\XdebugHandler vendor/composer/xdebug-handler/src/XdebugHandler.php @author John Stevenson <john-stevenson@blueyonder.co.uk> 4
XdebugNotAvailableException final class SebastianBergmann\CodeCoverage\Driver vendor/phpunit/php-code-coverage/src/Exception/XdebugNotAvailableException.php
XdebugNotEnabledException final class SebastianBergmann\CodeCoverage\Driver vendor/phpunit/php-code-coverage/src/Exception/XdebugNotEnabledException.php
Xml class PHP_CodeSniffer\Reports vendor/squizlabs/php_codesniffer/src/Reports/Xml.php
Xml final class PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Xml.php @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit 2
Xml final class PHPUnit\Util vendor/phpunit/phpunit/src/Util/Xml/Xml.php @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit 1
XmlConfigurationFileFinder final class PHPUnit\TextUI\CliArguments vendor/phpunit/phpunit/src/TextUI/Configuration/Cli/XmlConfigurationFileFinder.php @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit 2
XmlDescriptor class Symfony\Component\Console\Descriptor vendor/symfony/console/Descriptor/XmlDescriptor.php XML descriptor. 1
XmlDumper class Symfony\Component\DependencyInjection\Dumper vendor/symfony/dependency-injection/Dumper/XmlDumper.php XmlDumper dumps a service container as an XML string.
XmlEncoder class Symfony\Component\Serializer\Encoder vendor/symfony/serializer/Encoder/XmlEncoder.php @author Jordi Boggiano <j.boggiano@seld.be> @author John Wards <jwards@whiteoctober.co.uk> @author Fabian Vogler <fabian@equivalence.ch> @author Kévin Dunglas <dunglas@gmail.com> @author Dany Maillard… 3
XmlEncoder class Drupal\serialization\Encoder core/modules/serialization/src/Encoder/XmlEncoder.php Adds XML support for serializer. 2
XmlEncoderContextBuilder final class Symfony\Component\Serializer\Context\Encoder vendor/symfony/serializer/Context/Encoder/XmlEncoderContextBuilder.php A helper providing autocompletion for available XmlEncoder options.
XmlException final class PHPUnit\Util\Xml vendor/phpunit/phpunit/src/Util/Exception/XmlException.php @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit 7
XmlException final class SebastianBergmann\CodeCoverage vendor/phpunit/php-code-coverage/src/Exception/XmlException.php 1
XmlFileLoader class Symfony\Component\DependencyInjection\Loader vendor/symfony/dependency-injection/Loader/XmlFileLoader.php XmlFileLoader loads XML files service definitions. 2
XmlFileLoader class Symfony\Component\Routing\Loader vendor/symfony/routing/Loader/XmlFileLoader.php XmlFileLoader loads XML routing files.
XmlFileLoader class Symfony\Component\Serializer\Mapping\Loader vendor/symfony/serializer/Mapping/Loader/XmlFileLoader.php Loads XML mapping files.
XmlFileLoader class Symfony\Component\Validator\Mapping\Loader vendor/symfony/validator/Mapping/Loader/XmlFileLoader.php Loads validation metadata from an XML file. 1
XmlFilesLoader class Symfony\Component\Validator\Mapping\Loader vendor/symfony/validator/Mapping/Loader/XmlFilesLoader.php Loads validation metadata from a list of XML files.
XmlReaderCaster class Symfony\Component\VarDumper\Caster vendor/symfony/var-dumper/Caster/XmlReaderCaster.php Casts XmlReader class to array representation.
XmlResourceCaster class Symfony\Component\VarDumper\Caster vendor/symfony/var-dumper/Caster/XmlResourceCaster.php Casts XML resources to array representation.
XMLSerializer class TheSeer\Tokenizer vendor/theseer/tokenizer/src/XMLSerializer.php 1
XOAuth2Authenticator class Symfony\Component\Mailer\Transport\Smtp\Auth vendor/symfony/mailer/Transport/Smtp/Auth/XOAuth2Authenticator.php Handles XOAUTH2 authentication.