Classes, traits, and interfaces - main - drupal

Primary tabs

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
PreRequireEvent final class Drupal\package_manager\Event core/modules/package_manager/src/Event/PreRequireEvent.php Event fired before packages are updated to the stage directory. 16
PreventDowngradeTest class Drupal\Tests\system\Functional\UpdateSystem core/modules/system/tests/src/Functional/UpdateSystem/PreventDowngradeTest.php Tests that a site on 11.4.0 is prevented from downgrading to 12.0.0.
PreviewAwareBlock class Drupal\layout_builder_test\Plugin\Block core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Block/PreviewAwareBlock.php Defines a class for a context-aware block.
PreviewAwarePluginInterface interface Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/PreviewAwarePluginInterface.php Provides an interface to support preview mode injection in plugins. 2 4
PreviewFallbackInterface interface Drupal\Core\Render core/lib/Drupal/Core/Render/PreviewFallbackInterface.php Allows an element to provide a fallback representation of itself for preview. 1 4
PreviewTest class Drupal\Tests\views_ui\FunctionalJavascript core/modules/views_ui/tests/src/FunctionalJavascript/PreviewTest.php Tests the UI preview functionality.
PreviewTest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/PreviewTest.php Tests the UI preview functionality.
PreviewToggleTrait trait Drupal\layout_builder\Form core/modules/layout_builder/src/Form/PreviewToggleTrait.php Provides a trait that provides a toggle for the content preview.
PreWarmableInterface interface Drupal\Core\PreWarm core/lib/Drupal/Core/PreWarm/PreWarmableInterface.php Interface for services with prewarmable caches. 4 6
PreWarmablePluginManagerTrait trait Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/PreWarmablePluginManagerTrait.php Provides a trait for Drupal\Core\PreWarm\PreWarmableInterface. 3
PreWarmerTest class Drupal\KernelTests\Core\PreWarm core/tests/Drupal/KernelTests/Core/PreWarm/PreWarmerTest.php Tests the cache prewarmer.
PrimitiveBase abstract class Drupal\Core\TypedData core/lib/Drupal/Core/TypedData/PrimitiveBase.php Base class for primitive data types. 5 5
PrimitiveDataNormalizer class Drupal\serialization\Normalizer core/modules/serialization/src/Normalizer/PrimitiveDataNormalizer.php Converts primitive data objects to their casted values. 2 2
PrimitiveDataNormalizerTest class Drupal\Tests\serialization\Unit\Normalizer core/modules/serialization/tests/src/Unit/Normalizer/PrimitiveDataNormalizerTest.php Tests Drupal\serialization\Normalizer\PrimitiveDataNormalizer.
PrimitiveInterface interface Drupal\Core\TypedData core/lib/Drupal/Core/TypedData/PrimitiveInterface.php Interface for primitive data. 8 15
PrimitiveTypeConstraint class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraint.php Supports validating all primitive types. 2
PrimitiveTypeConstraintValidator class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidator.php Validates the PrimitiveType constraint. 1
PrimitiveTypeConstraintValidatorTest class Drupal\Tests\Core\Validation\Plugin\Validation\Constraint core/tests/Drupal/Tests/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidatorTest.php Tests Drupal\Core\Validation\Plugin\Validation\Constraint\PrimitiveTypeConstraintValidator.
PrivateFileOnTranslatedEntityTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/PrivateFileOnTranslatedEntityTest.php Uploads private files to translated node and checks access.
PrivateKey class Drupal\Core core/lib/Drupal/Core/PrivateKey.php Manages the Drupal private key. 9 2
PrivateKeyTest class Drupal\Tests\Core core/tests/Drupal/Tests/Core/PrivateKeyTest.php Tests the PrivateKey class.
PrivateMethodUnitTestTrait trait Drupal\Tests\ckeditor5\Traits core/modules/ckeditor5/tests/src/Traits/PrivateMethodUnitTestTrait.php Provides methods to test protected/private methods in unit tests. 2
PrivateStream class Drupal\Core\StreamWrapper core/lib/Drupal/Core/StreamWrapper/PrivateStream.php Drupal private (private://) stream wrapper class. 4
PrivateTempStore class Drupal\Core\TempStore core/lib/Drupal/Core/TempStore/PrivateTempStore.php Stores and retrieves temporary data for a given owner. 6
PrivateTempStoreFactory class Drupal\Core\TempStore core/lib/Drupal/Core/TempStore/PrivateTempStoreFactory.php Creates a PrivateTempStore object for a given collection. 12 2
PrivateTempStoreTest class Drupal\Tests\Core\TempStore core/tests/Drupal/Tests/Core/TempStore/PrivateTempStoreTest.php Tests Drupal\Core\TempStore\PrivateTempStore.
ProceduralCall final class Drupal\Core\Extension core/lib/Drupal/Core/Extension/ProceduralCall.php Helper class to target procedural implementations with hook order attributes. 4
ProceduralHookScanStop class Drupal\Core\Hook\Attribute core/lib/Drupal/Core/Hook/Attribute/ProceduralHookScanStop.php Defines a ProceduralHookScanStop attribute object. 3
ProceduralHookThemeHooks class Drupal\procedural_hook_theme\Hook core/modules/system/tests/themes/HookCollector/procedural_hook_theme/src/Hook/ProceduralHookThemeHooks.php Confirms LegacyHook works with themes.
ProcessedText class Drupal\filter\Element core/modules/filter/src/Element/ProcessedText.php Provides a processed text render element.
ProcessFactory final class Drupal\fixture_manipulator core/modules/package_manager/tests/modules/fixture_manipulator/src/ProcessFactory.php Process factory that always sets the COMPOSER_MIRROR_PATH_REPOS env variable.
ProcessField

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

class Drupal\field\Plugin\migrate\process core/modules/field/src/Plugin/migrate/process/ProcessField.php Get the value from a method call on a field plugin instance. 1
ProcessFieldTest class Drupal\Tests\field\Unit\Plugin\migrate\process core/modules/field/tests/src/Unit/Plugin/migrate/process/ProcessFieldTest.php Tests the ProcessField migrate process plugin.
ProcessingTest class Drupal\Tests\system\FunctionalJavascript\Batch core/modules/system/tests/src/FunctionalJavascript/Batch/ProcessingTest.php Tests Processing.
ProcessingTest class Drupal\Tests\system\Functional\Batch core/modules/system/tests/src/Functional/Batch/ProcessingTest.php Tests batch processing in form and non-form workflow.
ProcessOutputCallback final class Drupal\package_manager core/modules/package_manager/src/ProcessOutputCallback.php A process callback for capturing output. 3
ProcessOutputCallbackTest class Drupal\Tests\package_manager\Unit core/modules/package_manager/tests/src/Unit/ProcessOutputCallbackTest.php Tests Process Output Callback.
ProcessPluginBase abstract class Drupal\migrate core/modules/migrate/src/ProcessPluginBase.php The base class for all migrate process plugins. 78 78
ProcessPluginBase class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/ProcessPluginBaseTest.php Extends ProcessPluginBase as a non-abstract class.
ProcessPluginBaseTest class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/ProcessPluginBaseTest.php Tests the base process plugin class.
ProfileExtensionList class Drupal\Core\Extension core/lib/Drupal/Core/Extension/ProfileExtensionList.php Provides a list of installation profiles. 9 2
ProfileField class Drupal\user\Plugin\migrate\source core/modules/user/src/Plugin/migrate/source/ProfileField.php Drupal 6/7 profile field source from database. 2 3
ProfileFieldCheckRequirementsTest class Drupal\Tests\user\Kernel\Migrate\d6 core/modules/user/tests/src/Kernel/Migrate/d6/ProfileFieldCheckRequirementsTest.php Tests check requirements for profile_field source plugin.
ProfileFieldCheckRequirementsTest class Drupal\Tests\user\Kernel\Migrate\d7 core/modules/user/tests/src/Kernel/Migrate/d7/ProfileFieldCheckRequirementsTest.php Tests check requirements for profile_field source plugin.
ProfileFieldOptionTranslation class Drupal\user\Plugin\migrate\source\d6 core/modules/user/src/Plugin/migrate/source/d6/ProfileFieldOptionTranslation.php Drupal 6 i18n profile field option labels source from database. 1
ProfileFieldOptionTranslation

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

class Drupal\user\Plugin\migrate\process\d6 core/modules/user/src/Plugin/migrate/process/d6/ProfileFieldOptionTranslation.php Determines the settings property and translation.
ProfileFieldOptionTranslationTest class Drupal\Tests\user\Kernel\Plugin\migrate\source\d6 core/modules/user/tests/src/Kernel/Plugin/migrate/source/d6/ProfileFieldOptionTranslationTest.php Tests the field option translation source plugin.
ProfileFieldSettings

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

class Drupal\user\Plugin\migrate\process core/modules/user/src/Plugin/migrate/process/ProfileFieldSettings.php Determines the settings for the profile field.
ProfileFieldTest class Drupal\Tests\user\Kernel\Plugin\migrate\source core/modules/user/tests/src/Kernel/Plugin/migrate/source/ProfileFieldTest.php Tests the profile_field source plugin. 1 1
ProfileFieldTranslation class Drupal\config_translation\Plugin\migrate\source\d6 core/modules/config_translation/src/Plugin/migrate/source/d6/ProfileFieldTranslation.php Drupal 6 i18n strings profile field source from database. 1

Other projects


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