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
BadPluginDefinitionException class Drupal\migrate\Plugin\Exception core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php Defines a class for bad plugin definition exceptions. 3
BadRequestException class Symfony\Component\HttpFoundation\Exception vendor/symfony/http-foundation/Exception/BadRequestException.php Raised when a user sends a malformed request. 10
BadRequestHttpException class Symfony\Component\HttpKernel\Exception vendor/symfony/http-kernel/Exception/BadRequestHttpException.php @author Ben Ramsey <ben@benramsey.com> 2 23
BadResponseException class GuzzleHttp\Exception vendor/guzzlehttp/guzzle/src/Exception/BadResponseException.php Exception when an HTTP error occurs (4xx or 5xx error) 2 1
Baggage final class OpenTelemetry\API\Baggage vendor/open-telemetry/api/Baggage/Baggage.php 1
BaggageBuilder final class OpenTelemetry\API\Baggage vendor/open-telemetry/api/Baggage/BaggageBuilder.php
BaggageBuilderInterface interface OpenTelemetry\API\Baggage vendor/open-telemetry/api/Baggage/BaggageBuilderInterface.php 1 2
BaggageInterface interface OpenTelemetry\API\Baggage vendor/open-telemetry/api/Baggage/BaggageInterface.php 1
BaggagePropagator final class OpenTelemetry\API\Baggage\Propagation vendor/open-telemetry/api/Baggage/Propagation/BaggagePropagator.php
BanAdmin class Drupal\ban\Form core/modules/ban/src/Form/BanAdmin.php Displays banned IP addresses. 1
BanDelete class Drupal\ban\Form core/modules/ban/src/Form/BanDelete.php Provides a form to unban IP addresses. 1
BanHooks class Drupal\ban\Hook core/modules/ban/src/Hook/BanHooks.php Hook implementations for ban.
BanIpManager class Drupal\ban core/modules/ban/src/BanIpManager.php Ban IP manager. 2
BanIpManagerInterface interface Drupal\ban core/modules/ban/src/BanIpManagerInterface.php Provides an interface defining a BanIp manager. 1 3
BanMiddleware class Drupal\ban core/modules/ban/src/BanMiddleware.php Provides a HTTP middleware to implement IP based banning. 2
BareHtmlPageRenderer class Drupal\Core\Render core/lib/Drupal/Core/Render/BareHtmlPageRenderer.php Default bare HTML page renderer.
BareHtmlPageRenderer class Drupal\Core\ProxyClass\Render core/lib/Drupal/Core/ProxyClass/Render/BareHtmlPageRenderer.php Provides a proxy class for \Drupal\Core\Render\BareHtmlPageRenderer.
BareHtmlPageRendererInterface interface Drupal\Core\Render core/lib/Drupal/Core/Render/BareHtmlPageRendererInterface.php Bare HTML page renderer. 2 4
Base abstract class Peast\Formatter vendor/mck89/peast/lib/Peast/Formatter/Base.php Base class for formatters, all the formatters must extend this class. 3
Base64ContentEncoder final class Symfony\Component\Mime\Encoder vendor/symfony/mime/Encoder/Base64ContentEncoder.php @author Fabien Potencier <fabien@symfony.com> 1
Base64Encoder class Symfony\Component\Mime\Encoder vendor/symfony/mime/Encoder/Base64Encoder.php @author Chris Corbyn 2
Base64MimeHeaderEncoder final class Symfony\Component\Mime\Encoder vendor/symfony/mime/Encoder/Base64MimeHeaderEncoder.php @author Chris Corbyn
BaseCommand abstract class Composer\Command vendor/composer/composer/src/Composer/Command/BaseCommand.php Base class for Composer commands 32 1
BaseCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/BaseCommand.php Base command that only exists to simplify AJAX commands.
BaseConstraint class JsonSchema\Constraints vendor/justinrainbow/json-schema/src/JsonSchema/Constraints/BaseConstraint.php A more basic constraint definition - used for the public interface to avoid exposing library internals. 2 2
BaseDependencyCommand abstract class Composer\Command vendor/composer/composer/src/Composer/Command/BaseDependencyCommand.php Base implementation for commands mapping dependency relationships. 2
BaseDumper abstract class Twig\Profiler\Dumper vendor/twig/twig/src/Profiler/Dumper/BaseDumper.php @author Fabien Potencier <fabien@symfony.com> 2
BaseExcludeFilter abstract class Composer\Package\Archiver vendor/composer/composer/src/Composer/Package/Archiver/BaseExcludeFilter.php @author Nils Adermann <naderman@naderman.de> 2
BaseFieldDefinition class Drupal\Core\Field core/lib/Drupal/Core/Field/BaseFieldDefinition.php A class for defining entity fields. 32
BaseFieldFileFormatterBase abstract class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php Base class for file formatters, which allow to link to the file download URL. 4
BaseFieldOverride class Drupal\Core\Field\Entity core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php Defines the base field override entity. 1
BaseFieldOverrideAccessControlHandler class Drupal\Core\Field core/lib/Drupal/Core/Field/BaseFieldOverrideAccessControlHandler.php Provides en entity access control handler for base field override entity. 1
BaseFieldOverrideStorage class Drupal\Core\Field core/lib/Drupal/Core/Field/BaseFieldOverrideStorage.php Storage class for base field overrides. 1
BaseFileConstraintValidator abstract class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/BaseFileConstraintValidator.php Provides a base class for file constraint validators. 7
BaseFormIdInterface interface Drupal\Core\Form core/lib/Drupal/Core/Form/BaseFormIdInterface.php Provides an interface for a Form that has a base form ID. 5 5
BaseInstaller abstract class Composer\Installers vendor/composer/installers/src/Composer/Installers/BaseInstaller.php 96
BaseIO abstract class Composer\IO vendor/composer/composer/src/Composer/IO/BaseIO.php 2
Baseline final class PHPUnit\Runner\Baseline vendor/phpunit/phpunit/src/Runner/Baseline/Baseline.php @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit 1
BasePackage abstract class Composer\Package vendor/composer/composer/src/Composer/Package/BasePackage.php Base class for packages providing name storage and default match implementation 2 45
BaseRequirementsFulfilledValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/BaseRequirementsFulfilledValidator.php Validates that base requirements do not have any errors.
BaseRequirementValidatorTrait trait Drupal\package_manager\Validator core/modules/package_manager/src/Validator/BaseRequirementValidatorTrait.php Provides methods for base requirement validators.
BaseTag abstract class phpDocumentor\Reflection\DocBlock\Tags vendor/phpdocumentor/reflection-docblock/src/DocBlock/Tags/BaseTag.php Parses a tag definition for a DocBlock. 13
BashCompletionOutput class Symfony\Component\Console\Completion\Output vendor/symfony/console/Completion/Output/BashCompletionOutput.php @author Wouter de Jong <wouter@wouterj.nl> 1
Basic class Drupal\views\Plugin\views\exposed_form core/modules/views/src/Plugin/views/exposed_form/Basic.php Exposed form plugin that provides a basic exposed form.
BasicAuth class Drupal\basic_auth\Authentication\Provider core/modules/basic_auth/src/Authentication/Provider/BasicAuth.php HTTP Basic authentication provider. 2
BasicAuthHooks class Drupal\basic_auth\Hook core/modules/basic_auth/src/Hook/BasicAuthHooks.php Hook implementations for basic_auth.
BasicRecursiveValidatorFactory class Drupal\Core\Validation core/lib/Drupal/Core/Validation/BasicRecursiveValidatorFactory.php A factory for creating Symfony recursive validators. 2
BasicSettingsForm class Drupal\views_ui\Form core/modules/views_ui/src/Form/BasicSettingsForm.php Form builder for the admin display defaults page. 1
BasicStringFormatter class Drupal\Core\Field\Plugin\Field\FieldFormatter core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BasicStringFormatter.php Plugin implementation of the 'basic_string' formatter.
Batch class Drupal\Core\Queue core/lib/Drupal/Core/Queue/Batch.php Defines a batch queue handler used by the Batch API.