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
FriendsTrait trait Drupal\Tests\Core\Foo core/tests/PHPStan/fixtures/test-methods-with-metadata.php
FriendsWithFriendsTraitTest class Drupal\Tests\Core\Foo core/tests/PHPStan/fixtures/test-methods-with-metadata.php
FrontMatter class Drupal\Component\FrontMatter core/lib/Drupal/Component/FrontMatter/FrontMatter.php Component for parsing front matter from a source. 6
FrontMatterParseException class Drupal\Component\FrontMatter\Exception core/lib/Drupal/Component/FrontMatter/Exception/FrontMatterParseException.php Defines a class for front matter parsing exceptions. 3
FrontMatterTest class Drupal\KernelTests\Core\Theme core/tests/Drupal/KernelTests/Core/Theme/FrontMatterTest.php Tests Twig front matter support.
FrontMatterTest class Drupal\Tests\Component\FrontMatter core/tests/Drupal/Tests/Component/FrontMatter/FrontMatterTest.php Tests front matter parsing helper methods. 1
FrontPageTest class Drupal\Tests\node\Functional\Views core/modules/node/tests/src/Functional/Views/FrontPageTest.php Tests the default frontpage provided by views.
FrontPageTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/FrontPageTest.php Tests front page functionality and administration.
Fruit class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/EntityTypeRepositoryTest.php A simple entity for testing. 2
FruitInterface interface Drupal\plugin_test\Plugin\plugin_test\fruit core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/FruitInterface.php Provides an interface for test plugins. 4 1
Full class Drupal\views\Plugin\views\pager core/modules/views/src/Plugin/views/pager/Full.php The plugin to handle full pager. 2
FullDate class Drupal\views\Plugin\views\argument core/modules/views/src/Plugin/views/argument/FullDate.php Argument handler for a full date (CCYYMMDD)
FullDate class Drupal\datetime\Plugin\views\argument core/modules/datetime/src/Plugin/views/argument/FullDate.php Argument handler for a full date (CCYYMMDD).
FullyQualified final class Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Attribute core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Attribute/FullyQualified.php #[\Drupal\Tests\Component\Annotation\Doctrine\Fixtures\ExtraAttributes\ExampleAttribute]
FullyValidatableConstraint final class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/FullyValidatableConstraint.php Constraint for fully validatable config schema type. 4
FullyValidatableConstraintValidator final class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/FullyValidatableConstraintValidator.php FullyValidatable constraint.
FunctionalJavascriptTest final class Drupal\Tests\Component\Foo core/tests/PHPStan/fixtures/component-tests.php
FunctionalTest final class Drupal\Tests\Component\Foo core/tests/PHPStan/fixtures/component-tests.php
FunctionalTestDebugHtmlOutputHelperTest class Drupal\FunctionalTests\Test core/tests/Drupal/FunctionalTests/Test/FunctionalTestDebugHtmlOutputHelperTest.php Helper test for FunctionalTestDebugHtmlOutputTest.
FunctionalTestDebugHtmlOutputTest class Drupal\FunctionalTests\Test core/tests/Drupal/FunctionalTests/Test/FunctionalTestDebugHtmlOutputTest.php Test to ensure that functional tests produce debug HTML output when required.
FunctionalTestSetupTrait trait Drupal\Core\Test core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php Defines a trait for shared functional test setup functionality. 2
FunctionsTest class Drupal\Tests\system\Kernel\Theme core/modules/system/tests/src/Kernel/Theme/FunctionsTest.php Tests for common theme functions.
FundamentalCompatibilityConstraint class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraint.php The fundamental compatibility constraint.
FundamentalCompatibilityConstraintValidator class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraintValidator.php Validates fundamental compatibility of CKEditor 5 with the given text format. 1
GarbageCollectionTest class Drupal\KernelTests\Core\KeyValueStore core/tests/Drupal/KernelTests/Core/KeyValueStore/GarbageCollectionTest.php Tests garbage collection for the expirable key-value database storage.
GDImageToolkitOperationBase abstract class Drupal\system\Plugin\ImageToolkit\Operation\gd core/modules/system/src/Plugin/ImageToolkit/Operation/gd/GDImageToolkitOperationBase.php Provides a GD base class with correctly typed image toolkit. 7 1
GDToolkit class Drupal\system\Plugin\ImageToolkit core/modules/system/src/Plugin/ImageToolkit/GDToolkit.php Defines the GD2 toolkit for image manipulation within Drupal. 9
GdToolkitAvifImageManipulationTest class Drupal\KernelTests\Core\Image core/tests/Drupal/KernelTests/Core/Image/GdToolkitAvifImageManipulationTest.php GD image toolkit image manipulation of AVIF images.
GdToolkitGifImageManipulationTest class Drupal\KernelTests\Core\Image core/tests/Drupal/KernelTests/Core/Image/GdToolkitGifImageManipulationTest.php GD image toolkit image manipulation of GIF images.
GdToolkitImageManipulationTestBase abstract class Drupal\KernelTests\Core\Image core/tests/Drupal/KernelTests/Core/Image/GdToolkitImageManipulationTestBase.php GD image toolkit image manipulation test base class. 6
GdToolkitJpegImageManipulationTest class Drupal\KernelTests\Core\Image core/tests/Drupal/KernelTests/Core/Image/GdToolkitJpegImageManipulationTest.php GD image toolkit image manipulation of JPEG images.
GdToolkitNoTransparencyGifImageManipulationTest class Drupal\KernelTests\Core\Image core/tests/Drupal/KernelTests/Core/Image/GdToolkitNoTransparencyGifImageManipulationTest.php GD image toolkit image manipulation of no-transparency GIF images.
GdToolkitPngImageManipulationTest class Drupal\KernelTests\Core\Image core/tests/Drupal/KernelTests/Core/Image/GdToolkitPngImageManipulationTest.php GD image toolkit image manipulation of PNG images.
GdToolkitWebpImageManipulationTest class Drupal\KernelTests\Core\Image core/tests/Drupal/KernelTests/Core/Image/GdToolkitWebpImageManipulationTest.php GD image toolkit image manipulation of WEBP images.
GenerateAutoloadReferenceFile final class Drupal\Composer\Plugin\Scaffold composer/Plugin/Scaffold/GenerateAutoloadReferenceFile.php Generates an 'autoload.php' that includes the autoloader created by Composer.
GenerateAutoloadRuntimeReferenceFile final class Drupal\Composer\Plugin\Scaffold composer/Plugin/Scaffold/GenerateAutoloadRuntimeReferenceFile.php Generates an 'autoload_runtime.php' that includes the Symfony_runtime loader.
GeneratedButton class Drupal\Core core/lib/Drupal/Core/GeneratedButton.php This class holds a <button> generated from the <button> route. 2
GeneratedLink class Drupal\Core core/lib/Drupal/Core/GeneratedLink.php Used to return generated links, along with associated cacheability metadata. 2 3
GeneratedNoLink class Drupal\Core core/lib/Drupal/Core/GeneratedNoLink.php This class holds a <span> generated from the <nolink> route. 2
GeneratedUrl class Drupal\Core core/lib/Drupal/Core/GeneratedUrl.php Used to return generated URLs, along with associated bubbleable metadata. 25
GeneratePermutationsTrait trait Drupal\Tests\Traits\Core core/tests/Drupal/Tests/Traits/Core/GeneratePermutationsTrait.php Adds ability to convert a list of parameters into a stack of permutations. 3
GenerateProxyClassApplication class Drupal\Core\Command core/lib/Drupal/Core/Command/GenerateProxyClassApplication.php Provides a console command to generate proxy classes. 1
GenerateProxyClassCommand class Drupal\Core\Command core/lib/Drupal/Core/Command/GenerateProxyClassCommand.php Provides a console command to generate proxy classes.
GenerateTheme class Drupal\Core\Command core/lib/Drupal/Core/Command/GenerateTheme.php Generates a new theme based on latest default markup. 1
GenerateThemeTest class Drupal\BuildTests\Command core/tests/Drupal/BuildTests/Command/GenerateThemeTest.php Tests the generate-theme commands.
GeneratorNotInitializedException class Drupal\Core\Routing core/lib/Drupal/Core/Routing/GeneratorNotInitializedException.php Class for exceptions thrown when the generator has not been initialized.
GenericCacheBackendUnitTestBase abstract class Drupal\KernelTests\Core\Cache core/tests/Drupal/KernelTests/Core/Cache/GenericCacheBackendUnitTestBase.php Tests any cache backend. 8
GenericFileFormatter class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/GenericFileFormatter.php Plugin implementation of the 'file_default' formatter.
GenericModuleTestBase abstract class Drupal\Tests\system\Functional\Module core/modules/system/tests/src/Functional/Module/GenericModuleTestBase.php Runs a series of generic tests for one module. 74 74
GenericRecipeTestBase abstract class Drupal\Tests\system\Functional\Recipe core/modules/system/tests/src/Functional/Recipe/GenericRecipeTestBase.php Runs a series of generic tests for one recipe. 27 27

Other projects


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