Classes, traits, and interfaces - main - drupal

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
Finder		final class	Drupal\Core\DefaultContent	core/lib/Drupal/Core/DefaultContent/Finder.php	Finds all default content in a directory, in dependency order.		7
FinderTest		class	Drupal\Tests\Core\DefaultContent	core/tests/Drupal/Tests/Core/DefaultContent/FinderTest.php	Tests Finder.
FinishResponseSubscriber		class	Drupal\Core\EventSubscriber	core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php	Response subscriber to handle finished responses.		1	2
FinishResponseSubscriberTest		class	Drupal\Tests\Core\EventSubscriber	core/tests/Drupal/Tests/Core/EventSubscriber/FinishResponseSubscriberTest.php	Tests Drupal\Core\EventSubscriber\FinishResponseSubscriber.
FirstOrLast		class	Drupal\Core\Hook\OrderOperation	core/lib/Drupal/Core/Hook/OrderOperation/FirstOrLast.php	Moves one listener to the start or end of the list.		2
Fixed		class	Drupal\views\Plugin\views\argument_default	core/modules/views/src/Plugin/views/argument_default/Fixed.php	The fixed argument default handler.
FixtureDeprecatedClass		class	Drupal\deprecation_test\Deprecation	core/modules/system/tests/modules/deprecation_test/src/Deprecation/FixtureDeprecatedClass.php	Fixture for Drupal\FunctionalTests\Core\Container\ServiceDeprecationTest.		3	2
FixtureManipulator		class	Drupal\fixture_manipulator	core/modules/package_manager/tests/modules/fixture_manipulator/src/FixtureManipulator.php	Manipulates a test fixture using Composer commands.	2	4
FixtureManipulatorTest		class	Drupal\Tests\package_manager\Kernel	core/modules/package_manager/tests/src/Kernel/FixtureManipulatorTest.php	Tests Drupal\fixture_manipulator\FixtureManipulator.
FixtureManipulatorTrait		trait	Drupal\Tests\package_manager\Traits	core/modules/package_manager/tests/src/Traits/FixtureManipulatorTrait.php	A trait for common fixture manipulator functions.		1
Fixtures		class	Drupal\Tests\Composer\Generator	core/tests/Drupal/Tests/Composer/Generator/Fixtures.php	Convenience class for creating fixtures.
Fixtures		class	Drupal\Tests\Composer\Plugin\Unpack	core/tests/Drupal/Tests/Composer/Plugin/Unpack/Fixtures.php	Fixture for testing the unpack composer plugin.		1
Fixtures		class	Drupal\Tests\Composer\Plugin\Scaffold	core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Fixtures.php	Convenience class for creating fixtures.		9
FixturesBase		abstract class	Drupal\Tests\Composer\Plugin	core/tests/Drupal/Tests/Composer/Plugin/FixturesBase.php	Base class for fixtures to test composer plugins.	2	2
FixtureUtilityTrait		trait	Drupal\Tests\package_manager\Traits	core/modules/package_manager/tests/src/Traits/FixtureUtilityTrait.php	A utility for all things fixtures.		3
Flatten		class	Drupal\migrate\Plugin\migrate\process	core/modules/migrate/src/Plugin/migrate/process/Flatten.php	Flattens the source value.		1
FlattenTest		class	Drupal\Tests\migrate\Unit\process	core/modules/migrate/tests/src/Unit/process/FlattenTest.php	Tests the flatten plugin.
FloatData		class	Drupal\Core\TypedData\Plugin\DataType	core/lib/Drupal/Core/TypedData/Plugin/DataType/FloatData.php	The float data type.		2	1
FloatInterface		interface	Drupal\Core\TypedData\Type	core/lib/Drupal/Core/TypedData/Type/FloatInterface.php	Interface for floating-point numbers.	1	5
FloatItem		class	Drupal\Core\Field\Plugin\Field\FieldType	core/lib/Drupal/Core/Field/Plugin/Field/FieldType/FloatItem.php	Defines the 'float' field type.
FloodInterface		interface	Drupal\Core\Flood	core/lib/Drupal/Core/Flood/FloodInterface.php	Defines an interface for flood controllers.	3	6
FloodTest		class	Drupal\Tests\system\Kernel\System	core/modules/system/tests/src/Kernel/System/FloodTest.php	Functional tests for the flood control mechanism.
FocusFirstCommand		class	Drupal\Core\Ajax	core/lib/Drupal/Core/Ajax/FocusFirstCommand.php	AJAX command for focusing an element.		4
FocusFirstCommandTest		class	Drupal\FunctionalJavascriptTests\Ajax	core/tests/Drupal/FunctionalJavascriptTests/Ajax/FocusFirstCommandTest.php	Tests setting focus via AJAX command.
FolderTest		class	Drupal\FunctionalTests	core/tests/Drupal/FunctionalTests/FolderTest.php	Tests BrowserTestBase's treatment of hook_install() during setup.
FollowUpMigrationsTest		class	Drupal\Tests\migrate_drupal\Kernel\d6	core/modules/migrate_drupal/tests/src/Kernel/d6/FollowUpMigrationsTest.php	Tests follow-up migrations.
FollowUpMigrationsTest		class	Drupal\Tests\migrate_drupal\Kernel\d7	core/modules/migrate_drupal/tests/src/Kernel/d7/FollowUpMigrationsTest.php	Tests follow-up migrations.
Foo		class	Drupal\image_test\Plugin\ImageToolkit\Operation\test	core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/Foo.php	Builds an image toolkit operation.
FooAccessPolicy		class	Drupal\Tests\Core\Session	core/tests/Drupal/Tests/Core/Session/AccessPolicyProcessorTest.php	A test access policy for admin and for 'foo' and 'bar' permissions.
FooCacheContext		class	Drupal\Tests\Core\Cache\Context	core/tests/Drupal/Tests/Core/Cache/Context/CacheContextsManagerTest.php	Fake cache context class.
FooDerived		class	Drupal\image_test\Plugin\ImageToolkit\Operation\test	core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/FooDerived.php	Builds an image toolkit operation.
FooTest		final class	Drupal\Tests\Component\Foo	core/tests/PHPStan/fixtures/component-tests.php
Form		class	Drupal\Core\Render\Element	core/lib/Drupal/Core/Render/Element/Form.php	Provides a render element for a form.
Form		class	Drupal\router_test	core/modules/system/tests/modules/router_test_directory/src/Form.php	Form to test _form routing.			1
FormActionXssTest		class	Drupal\KernelTests\Core\Form	core/tests/Drupal/KernelTests/Core/Form/FormActionXssTest.php	Ensures that a form's action attribute can't be exploited with XSS.
FormAjaxException		class	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormAjaxException.php	Custom exception to break out of AJAX form processing.		2
FormAjaxResponseBuilder		class	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormAjaxResponseBuilder.php	Builds an AJAX form response.		1	2
FormAjaxResponseBuilderInterface		interface	Drupal\Core\Form	core/lib/Drupal/Core/Form/FormAjaxResponseBuilderInterface.php	Provides an interface for building AJAX form responses.	1	2
FormAjaxResponseBuilderTest		class	Drupal\Tests\Core\Form	core/tests/Drupal/Tests/Core/Form/FormAjaxResponseBuilderTest.php	Tests Drupal\Core\Form\FormAjaxResponseBuilder.
FormAjaxSubscriber		class	Drupal\Core\Form\EventSubscriber	core/lib/Drupal/Core/Form/EventSubscriber/FormAjaxSubscriber.php	Wraps AJAX form submissions that are triggered via an exception.		1	2
FormAjaxSubscriberTest		class	Drupal\Tests\Core\Form\EventSubscriber	core/tests/Drupal/Tests/Core/Form/EventSubscriber/FormAjaxSubscriberTest.php	Tests Drupal\Core\Form\EventSubscriber\FormAjaxSubscriber.
FormatDate		class	Drupal\migrate\Plugin\migrate\process	core/modules/migrate/src/Plugin/migrate/process/FormatDate.php	Converts date/datetime from one format to another.		1
FormatDateTest		class	Drupal\Tests\migrate\Unit\process	core/modules/migrate/tests/src/Unit/process/FormatDateTest.php	Tests the format date process plugin.
FormatDateTest		class	Drupal\Tests\system\Functional\Common	core/modules/system/tests/src/Functional/Common/FormatDateTest.php	Tests the DateFormatterInterface::format() function.
FormatPluralUpdateTest		class	Drupal\Tests\views\Functional\Update	core/modules/views/tests/src/Functional/Update/FormatPluralUpdateTest.php	Tests the upgrade path for converting format_plural from integer to boolean.
FormattableMarkup		class	Drupal\Component\Render	core/lib/Drupal/Component/Render/FormattableMarkup.php	Formats a string for HTML display by replacing variable placeholders.	1	49
FormattableMarkupKernelTest		class	Drupal\KernelTests\Component\Render	core/tests/Drupal/KernelTests/Component/Render/FormattableMarkupKernelTest.php	Provides a test covering integration of FormattableMarkup with other systems.
FormattableMarkupTest		class	Drupal\Tests\Component\Render	core/tests/Drupal/Tests/Component/Render/FormattableMarkupTest.php	Tests the TranslatableMarkup class.
FormattedDateDiff		class	Drupal\Core\Datetime	core/lib/Drupal/Core/Datetime/FormattedDateDiff.php	Contains a formatted time difference.		1
FormatterBase		abstract class	Drupal\Core\Field	core/lib/Drupal/Core/Field/FormatterBase.php	Base class for 'Field formatter' plugin implementations.	33	33

Other projects

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