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
File		class	Drupal\file\Plugin\views\field	core/modules/file/src/Plugin/views/field/File.php	Field handler to provide simple renderer that allows linking to a file.
File		class	Drupal\file\Plugin\views\wizard	core/modules/file/src/Plugin/views/wizard/File.php	Tests creating managed files views with the wizard.
File		class	Drupal\file\Plugin\migrate\source\d6	core/modules/file/src/Plugin/migrate/source/d6/File.php	Drupal 6 file source from database.		1
File		class	Drupal\file\Plugin\migrate\source\d7	core/modules/file/src/Plugin/migrate/source/d7/File.php	Drupal 7 file source from database.	1	2
FileAccessControlHandler		class	Drupal\file	core/modules/file/src/FileAccessControlHandler.php	Provides a File access control handler.	1	2
FileAccessFormatterControlHandlerInterface		interface	Drupal\file	core/modules/file/src/FileAccessFormatterControlHandlerInterface.php	Defines an interface for file access handlers which runs on file formatters.	1	1
FileAudioFormatter		class	Drupal\file\Plugin\Field\FieldFormatter	core/modules/file/src/Plugin/Field/FieldFormatter/FileAudioFormatter.php	Plugin implementation of the 'file_audio' formatter.		1
FileAudioFormatterTest		class	Drupal\Tests\file\Functional\Formatter	core/modules/file/tests/src/Functional/Formatter/FileAudioFormatterTest.php	Tests Drupal\file\Plugin\Field\FieldFormatter\FileAudioFormatter.
FileCache		class	Drupal\Component\FileCache	core/lib/Drupal/Component/FileCache/FileCache.php	Allows to cache data based on file modification dates.	1	4
FileCacheBackendInterface		interface	Drupal\Component\FileCache	core/lib/Drupal/Component/FileCache/FileCacheBackendInterface.php	Defines an interface inspired by APCu for FileCache backends.	2	1
FileCacheFactory		class	Drupal\Component\FileCache	core/lib/Drupal/Component/FileCache/FileCacheFactory.php	Creates a FileCache object.		25
FileCacheFactoryTest		class	Drupal\Tests\Component\FileCache	core/tests/Drupal/Tests/Component/FileCache/FileCacheFactoryTest.php	Tests Drupal\Component\FileCache\FileCacheFactory.
FileCacheInterface		interface	Drupal\Component\FileCache	core/lib/Drupal/Component/FileCache/FileCacheInterface.php	Interface for objects that allow caching file data.	2	2
FileCacheTest		class	Drupal\Tests\Component\FileCache	core/tests/Drupal/Tests/Component/FileCache/FileCacheTest.php	Tests Drupal\Component\FileCache\FileCache.
FileCopy		class	Drupal\migrate\Plugin\migrate\process	core/modules/migrate/src/Plugin/migrate/process/FileCopy.php	Copies or moves a local file from one place into another.	1	2
FileCopyTest		class	Drupal\Tests\migrate\Unit\process	core/modules/migrate/tests/src/Unit/process/FileCopyTest.php	Tests the file copy process plugin.
FileCopyTest		class	Drupal\Tests\migrate\Kernel\process	core/modules/migrate/tests/src/Kernel/process/FileCopyTest.php	Tests the file_copy process plugin.
FileCopyTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileCopyTest.php	Tests the unmanaged file copy function.	1
FileDeleteGadgetChainTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileDeleteGadgetChainTest.php	Tests protection against SA-CORE-2024-006 File Delete Gadget Chain.
FileDeleteRecursiveRemoteTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileDeleteRecursiveRemoteTest.php	Tests deleteRecursive() with remote stream wrappers where realpath() is FALSE.
FileDeleteRecursiveTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileDeleteRecursiveTest.php	Tests the unmanaged file delete recursive function.	1
FileDeleteTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileDeleteTest.php	Tests the unmanaged file delete function.	1
FileDeprecatedTestThemeHooks		class	Drupal\file_deprecated_test\Hook	core/modules/file/tests/file_deprecated_test/src/Hook/FileDeprecatedTestThemeHooks.php	Hook implementations for file_deprecated_test.
FileDownloadController		class	Drupal\system	core/modules/system/src/FileDownloadController.php	System file controller.	2	3
FileDownloadHook		class	Drupal\file\Hook	core/modules/file/src/Hook/FileDownloadHook.php	Implements hook_file_download().
FileElementTest		class	Drupal\Tests\system\Kernel\Form	core/modules/system/tests/src/Kernel/Form/FileElementTest.php	Tests for the 'file' form element.
FileEncodingConstraint		class	Drupal\file\Plugin\Validation\Constraint	core/modules/file/src/Plugin/Validation/Constraint/FileEncodingConstraint.php	Defines an encoding constraint for files.
FileEncodingConstraintValidator		class	Drupal\file\Plugin\Validation\Constraint	core/modules/file/src/Plugin/Validation/Constraint/FileEncodingConstraintValidator.php	Validates the file encoding constraint.		1
FileEncodingConstraintValidatorTest		class	Drupal\Tests\file\Kernel\Plugin\Validation\Constraint	core/modules/file/tests/src/Kernel/Plugin/Validation/Constraint/FileEncodingConstraintValidatorTest.php	Tests the FileEncodingConstraintValidator.
FileEntityFormatterTest		class	Drupal\Tests\file\Kernel\Formatter	core/modules/file/tests/src/Kernel/Formatter/FileEntityFormatterTest.php	Tests the default file formatter.
FileEventSubscriber		class	Drupal\file\EventSubscriber	core/modules/file/src/EventSubscriber/FileEventSubscriber.php	Sanitizes uploaded filenames.		1	2
FileException		class	Drupal\Core\File\Exception	core/lib/Drupal/Core/File/Exception/FileException.php	Base class for exceptions related to file handling operations.	7	28
FileExistsException		class	Drupal\Core\File\Exception	core/lib/Drupal/Core/File/Exception/FileExistsException.php	Exception thrown when a file unexpectedly exists.		10
FileExtensionConstraint		class	Drupal\file\Plugin\Validation\Constraint	core/modules/file/src/Plugin/Validation/Constraint/FileExtensionConstraint.php	File extension constraint.
FileExtensionConstraintValidator		class	Drupal\file\Plugin\Validation\Constraint	core/modules/file/src/Plugin/Validation/Constraint/FileExtensionConstraintValidator.php	Validates the file extension constraint.		1
FileExtensionConstraintValidatorTest		class	Drupal\Tests\file\Kernel\Plugin\Validation\Constraint	core/modules/file/tests/src/Kernel/Plugin/Validation/Constraint/FileExtensionConstraintValidatorTest.php	Tests the FileExtensionConstraintValidator.
FileExtensionFormatter		class	Drupal\file\Plugin\Field\FieldFormatter	core/modules/file/src/Plugin/Field/FieldFormatter/FileExtensionFormatter.php	Formatter to render a filename as file extension.
FileExtensionSecureConstraint		class	Drupal\file\Plugin\Validation\Constraint	core/modules/file/src/Plugin/Validation/Constraint/FileExtensionSecureConstraint.php	File extension secure constraint.
FileExtensionSecureConstraintValidator		class	Drupal\file\Plugin\Validation\Constraint	core/modules/file/src/Plugin/Validation/Constraint/FileExtensionSecureConstraintValidator.php	Validator for the FileExtensionSecureConstraint.		1
FileExtensionSecureConstraintValidatorTest		class	Drupal\Tests\file\Kernel\Plugin\Validation\Constraint	core/modules/file/tests/src/Kernel/Plugin/Validation/Constraint/FileExtensionSecureConstraintValidatorTest.php	Tests the FileExtensionSecureConstraintValidator.
FileField		class	Drupal\file\Plugin\migrate\field\d6	core/modules/file/src/Plugin/migrate/field/d6/FileField.php	MigrateField Plugin for Drupal 6 file fields.	2	3
FileField		class	Drupal\file\Plugin\migrate\field\d7	core/modules/file/src/Plugin/migrate/field/d7/FileField.php	MigrateField Plugin for Drupal 7 file fields.		1
FileFieldAnonymousSubmissionTest		class	Drupal\Tests\file\Functional	core/modules/file/tests/src/Functional/FileFieldAnonymousSubmissionTest.php	Confirm that file field submissions work correctly for anonymous visitors.
FileFieldCreationTrait		trait	Drupal\Tests\file\Functional	core/modules/file/tests/src/Functional/FileFieldCreationTrait.php	Provides methods for creating file fields.		6
FileFieldDisplayTest		class	Drupal\Tests\file\Functional	core/modules/file/tests/src/Functional/FileFieldDisplayTest.php	Tests the display of file fields in node and views.
FileFieldFormatterAccessTest		class	Drupal\Tests\file\Functional	core/modules/file/tests/src/Functional/FileFieldFormatterAccessTest.php	Tests file formatter access.
FileFieldItemList		class	Drupal\file\Plugin\Field\FieldType	core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php	Represents a configurable entity file field.		3
FileFieldPathTest		class	Drupal\Tests\file\Functional	core/modules/file/tests/src/Functional/FileFieldPathTest.php	Tests that files are uploaded to proper locations.
FileFieldRevisionTest		class	Drupal\Tests\file\Functional	core/modules/file/tests/src/Functional/FileFieldRevisionTest.php	Tests creating and deleting revisions with files attached.
FileFieldRSSContentTest		class	Drupal\Tests\file\Functional	core/modules/file/tests/src/Functional/FileFieldRSSContentTest.php	Ensure that files added to nodes appear correctly in RSS feeds.

Other projects

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