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
PluginTest class Drupal\Tests\Component\Annotation core/tests/Drupal/Tests/Component/Annotation/PluginTest.php Tests Drupal\Component\Annotation\Plugin.
PluginTest class Drupal\Tests\Component\Plugin\Attribute core/tests/Drupal/Tests/Component/Plugin/Attribute/PluginTest.php Tests Drupal\Component\Plugin\Attribute\Plugin.
PluginTestBase abstract class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/PluginTestBase.php Base class for Plugin API unit tests. 3
PluginTestHooks class Drupal\plugin_test\Hook core/modules/system/tests/modules/plugin_test/src/Hook/PluginTestHooks.php Hook implementations for plugin_test.
PluginTypeListTest class Drupal\Tests\views\Unit core/modules/views/tests/src/Unit/PluginTypeListTest.php Tests that list of plugin is correct.
PluginWithFormsInterface interface Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/PluginWithFormsInterface.php Provides an interface for plugins which have forms. 6 14
PluginWithFormsTrait trait Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/PluginWithFormsTrait.php Provides a trait with typical behavior for plugins which have forms. 5
PluginWithFormsTraitTest class Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/PluginWithFormsTraitTest.php Tests Drupal\Core\Plugin\PluginWithFormsTrait.
PluralFormula class Drupal\locale core/modules/locale/src/PluralFormula.php Manages the storage of plural formula per language in state. 2
PluralFormulaInterface interface Drupal\locale core/modules/locale/src/PluralFormulaInterface.php An interface for a service providing plural formulas. 1
PluralTranslatableMarkup class Drupal\Core\StringTranslation core/lib/Drupal/Core/StringTranslation/PluralTranslatableMarkup.php A class to hold plural translatable markup. 15
PluralTranslatableMarkupTest class Drupal\Tests\Core\StringTranslation core/tests/Drupal/Tests/Core/StringTranslation/PluralTranslatableMarkupTest.php Tests the TranslatableMarkup class.
PluralTranslation class Drupal\Core\Annotation core/lib/Drupal/Core/Annotation/PluralTranslation.php Defines an annotation object for strings that require plural forms. 1
PluralTranslationTest class Drupal\Tests\Core\Annotation core/tests/Drupal/Tests/Core/Annotation/PluralTranslationTest.php Tests Drupal\Core\Annotation\PluralTranslation.
PluralVariants class Drupal\config_translation\FormElement core/modules/config_translation/src/FormElement/PluralVariants.php Defines form elements for plurals in configuration translation.
PoDatabaseReader class Drupal\locale core/modules/locale/src/PoDatabaseReader.php Gettext PO reader working with the locale module database. 1
PoDatabaseWriter class Drupal\locale core/modules/locale/src/PoDatabaseWriter.php Gettext PO writer working with the locale module database.
PoHeader class Drupal\Component\Gettext core/lib/Drupal/Component/Gettext/PoHeader.php Gettext PO header handler. 5
PoHeaderTest class Drupal\Tests\Component\Gettext core/tests/Drupal/Tests/Component/Gettext/PoHeaderTest.php Unit tests for the Gettext PO file header handling features.
PoItem class Drupal\Component\Gettext core/lib/Drupal/Component/Gettext/PoItem.php PoItem handles one translation. 18
PoItemTest class Drupal\Tests\Component\Gettext core/tests/Drupal/Tests/Component/Gettext/PoItemTest.php Tests Drupal\Component\Gettext\PoItem.
PoMemoryWriter class Drupal\Component\Gettext core/lib/Drupal/Component/Gettext/PoMemoryWriter.php Defines a Gettext PO memory writer, to be used by the installer. 1
PoMetadataInterface interface Drupal\Component\Gettext core/lib/Drupal/Component/Gettext/PoMetadataInterface.php Methods required for both reader and writer implementations. 2
PoReaderInterface interface Drupal\Component\Gettext core/lib/Drupal/Component/Gettext/PoReaderInterface.php Shared interface definition for all Gettext PO Readers. 2 2
PositionShimTestController class Drupal\position_shim_test\Controller core/modules/system/tests/modules/position_shim_test/src/Controller/PositionShimTestController.php The position shim test controller.
PositionShimTestPortedJqueryTestsController class Drupal\position_shim_test\Controller core/modules/system/tests/modules/position_shim_test/src/Controller/PositionShimTestPortedJqueryTestsController.php Controller for the testing jQuery UI position shim.
PostApplyEvent final class Drupal\package_manager\Event core/modules/package_manager/src/Event/PostApplyEvent.php Event fired after staged changes are synced to the active directory. 10
PostApplySubscriber class Drupal\updated_module core/modules/package_manager/tests/fixtures/build_test_projects/updated_module/1.1.0/src/PostApplySubscriber.php Writes a file after staged changes are applied to the active directory. 2
PostCreateEvent final class Drupal\package_manager\Event core/modules/package_manager/src/Event/PostCreateEvent.php Event fired after a stage directory has been created. 9
PostgresqlDateSql class Drupal\views\Plugin\views\query core/modules/views/src/Plugin/views/query/PostgresqlDateSql.php PostgreSQL-specific date handling. 1 2
PostgresqlDateSqlTest class Drupal\Tests\views\Unit\Plugin\views\query core/modules/views/tests/src/Unit/Plugin/views/query/PostgresqlDateSqlTest.php Tests the PostgreSQL-specific date query handler.
PostPackageEventListenerInterface interface Drupal\Composer\Plugin\Scaffold composer/Plugin/Scaffold/PostPackageEventListenerInterface.php Interface for post package event listeners. 1
PoStreamInterface interface Drupal\Component\Gettext core/lib/Drupal/Component/Gettext/PoStreamInterface.php Common functions for file/stream based PO readers/writers. 2
PoStreamReader class Drupal\Component\Gettext core/lib/Drupal/Component/Gettext/PoStreamReader.php Implements Gettext PO stream reader. 3
PoStreamReaderTest class Drupal\Tests\Component\Gettext core/tests/Drupal/Tests/Component/Gettext/PoStreamReaderTest.php Unit tests for the Gettext PO file header handling features.
PoStreamWriter class Drupal\Component\Gettext core/lib/Drupal/Component/Gettext/PoStreamWriter.php Defines a Gettext PO stream writer. 2
PoStreamWriterTest class Drupal\Tests\Component\Gettext core/tests/Drupal/Tests/Component/Gettext/PoStreamWriterTest.php Tests Drupal\Component\Gettext\PoStreamWriter.
PostRequireEvent final class Drupal\package_manager\Event core/modules/package_manager/src/Event/PostRequireEvent.php Event fired after packages are updated to the stage directory. 8
PostSaveProcess class Drupal\views core/modules/views/src/PostSaveProcess.php Defines the post save process value object. 5
PostSaveProcessTest class Drupal\Tests\views\Unit core/modules/views/tests/src/Unit/PostSaveProcessTest.php Tests Drupal\views\PostSaveProcess.
PostSaveViewInterface interface Drupal\views core/modules/views/src/PostSaveViewInterface.php Provides an interface for views plugins. 3 4
PoWriterInterface interface Drupal\Component\Gettext core/lib/Drupal/Component/Gettext/PoWriterInterface.php Shared interface definition for all Gettext PO Writers. 3 1
PreApplyEvent final class Drupal\package_manager\Event core/modules/package_manager/src/Event/PreApplyEvent.php Event fired before staged changes are synced to the active directory. 43
PrecedingConstraintAwareValidatorTrait trait Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/PrecedingConstraintAwareValidatorTrait.php A constraint may need preceding constraints to not have been violated.
PreconfiguredFieldUiOptionsInterface interface Drupal\Core\Field core/lib/Drupal/Core/Field/PreconfiguredFieldUiOptionsInterface.php Defines an interface for exposing "preconfigured" field definitions. 2 2
PreCreateEvent final class Drupal\package_manager\Event core/modules/package_manager/src/Event/PreCreateEvent.php Event fired before a stage directory is created. 38
PredefinedStatesWorkflowTestType class Drupal\workflow_type_test\Plugin\WorkflowType core/modules/workflows/tests/modules/workflow_type_test/src/Plugin/WorkflowType/PredefinedStatesWorkflowTestType.php Test workflow type.
PredefinedWorkflowTypeTest class Drupal\Tests\workflows\Kernel core/modules/workflows/tests/src/Kernel/PredefinedWorkflowTypeTest.php Test a predefined workflow based on something other than configuration.
PreEntityImportEvent final class Drupal\Core\DefaultContent core/lib/Drupal/Core/DefaultContent/PreEntityImportEvent.php Event dispatched before an entity is created during default content import. 1
PreExistingConfigException class Drupal\Core\Config core/lib/Drupal/Core/Config/PreExistingConfigException.php An exception thrown if configuration with the same name already exists. 7

Other projects


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