Classes, traits, and interfaces - 9.5.x - 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 1523

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
IHaveRuntimeContexts		class	Drupal\layout_builder_test\ContextProvider	core/modules/layout_builder/tests/modules/layout_builder_test/src/ContextProvider/IHaveRuntimeContexts.php	Defines a class for a fake context provider.			2
IHaveRuntimeContexts		class	Drupal\layout_builder_test\Plugin\Block	core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Block/IHaveRuntimeContexts.php	Defines a class for a context-aware block.
Iid		class	Drupal\aggregator\Plugin\views\argument	core/modules/aggregator/src/Plugin/views/argument/Iid.php	Argument handler to accept an aggregator item id.
Image		class	Drupal\quickedit\Plugin\InPlaceEditor	core/modules/quickedit/src/Plugin/InPlaceEditor/Image.php	Defines the image text in-place editor.
Image	in drupal:9.4.0 and is removed from drupal:10.0.0. Use the Drupal\quickedit\Plugin\InPlaceEditor\Image in-place editor instead.	class	Drupal\image\Plugin\InPlaceEditor	core/modules/image/src/Plugin/InPlaceEditor/Image.php	Defines the image text in-place editor.
Image		class	Drupal\ckeditor5\Plugin\CKEditor5Plugin	core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Image.php	CKEditor 5 Image plugin.			1
Image		class	Drupal\media\Plugin\media\Source	core/modules/media/src/Plugin/media/Source/Image.php	Image entity media source.		3
Image		class	Drupal\Core\Image	core/lib/Drupal/Core/Image/Image.php	Defines an image object to represent an image file.		1
Image		class	Drupal\Component\Utility	core/lib/Drupal/Component/Utility/Image.php	Provides helpers to operate on images.		2
ImageAdminStylesTest		class	Drupal\Tests\image\FunctionalJavascript	core/modules/image/tests/src/FunctionalJavascript/ImageAdminStylesTest.php	Tests creation, deletion, and editing of image styles and effects.
ImageAdminStylesTest		class	Drupal\Tests\image\Functional	core/modules/image/tests/src/Functional/ImageAdminStylesTest.php	Tests creation, deletion, and editing of image styles and effects.
ImageButton		class	Drupal\Core\Render\Element	core/lib/Drupal/Core/Render/Element/ImageButton.php	Provides a form element for a submit button with an image.
ImageCacheActions		class	Drupal\image\Plugin\migrate\process\d6	core/modules/image/src/Plugin/migrate/process/d6/ImageCacheActions.php	Plugin annotation @MigrateProcessPlugin( id = "d6_imagecache_actions" )
ImageCachePreset		class	Drupal\image\Plugin\migrate\source\d6	core/modules/image/src/Plugin/migrate/source/d6/ImageCachePreset.php	Drupal 6 imagecache presets source from database.
ImageCachePresetTest		class	Drupal\Tests\image\Kernel\Plugin\migrate\source\d6	core/modules/image/tests/src/Kernel/Plugin/migrate/source/d6/ImageCachePresetTest.php	Tests the d6_imagecache_presets source plugin.
ImageConfigUpdater		final class	Drupal\image	core/modules/image/src/ImageConfigUpdater.php	Provides a BC layer for modules providing old configurations.		2
ImageDimensionsTest		class	Drupal\Tests\image\Functional	core/modules/image/tests/src/Functional/ImageDimensionsTest.php	Tests that images have correct dimensions when styled.
ImageEffect		class	Drupal\image\Annotation	core/modules/image/src/Annotation/ImageEffect.php	Defines an image effect annotation object.
ImageEffectAddForm		class	Drupal\image\Form	core/modules/image/src/Form/ImageEffectAddForm.php	Provides an add form for image effects.			1
ImageEffectBase		abstract class	Drupal\image	core/modules/image/src/ImageEffectBase.php	Provides a base class for image effects.	4	4
ImageEffectDeleteForm		class	Drupal\image\Form	core/modules/image/src/Form/ImageEffectDeleteForm.php	Form for deleting an image effect.			1
ImageEffectEditForm		class	Drupal\image\Form	core/modules/image/src/Form/ImageEffectEditForm.php	Provides an edit form for image effects.		1	1
ImageEffectFormBase		abstract class	Drupal\image\Form	core/modules/image/src/Form/ImageEffectFormBase.php	Provides a base form for image effects.	2
ImageEffectInterface		interface	Drupal\image	core/modules/image/src/ImageEffectInterface.php	Defines the interface for image effects.	2	1
ImageEffectManager		class	Drupal\image	core/modules/image/src/ImageEffectManager.php	Manages image effect plugins.		2	2
ImageEffectPluginCollection		class	Drupal\image	core/modules/image/src/ImageEffectPluginCollection.php	A collection of image effects.		2
ImageEffectsTest		class	Drupal\Tests\image\Kernel	core/modules/image/tests/src/Kernel/ImageEffectsTest.php	Tests image effects.
ImageFactory		class	Drupal\Core\Image	core/lib/Drupal/Core/Image/ImageFactory.php	Provides a factory for image objects.		6	2
ImageField		class	Drupal\image\Plugin\migrate\field\d6	core/modules/image/src/Plugin/migrate/field/d6/ImageField.php	Plugin annotation @MigrateField( id = "imagefield", core = {6}, source_module = "imagefield", destination_module = "image" )
ImageField		class	Drupal\image\Plugin\migrate\field\d7	core/modules/image/src/Plugin/migrate/field/d7/ImageField.php	Plugin annotation @MigrateField( id = "image", core = {7}, source_module = "image", destination_module = "image" )
ImageFieldAttributesTest		class	Drupal\Tests\rdf\Functional	core/modules/rdf/tests/src/Functional/ImageFieldAttributesTest.php	Tests the RDFa markup of imagefields.
ImageFieldCreationTrait		trait	Drupal\Tests\image\Kernel	core/modules/image/tests/src/Kernel/ImageFieldCreationTrait.php	Provides a helper method for creating Image fields.		9
ImageFieldDefaultImagesTest		class	Drupal\Tests\image\Functional	core/modules/image/tests/src/Functional/ImageFieldDefaultImagesTest.php	Tests setting up default images both to the field and field storage.
ImageFieldDisplayTest		class	Drupal\Tests\image\Functional	core/modules/image/tests/src/Functional/ImageFieldDisplayTest.php	Tests the display of image fields.
ImageFieldTestBase		abstract class	Drupal\Tests\image\FunctionalJavascript	core/modules/image/tests/src/FunctionalJavascript/ImageFieldTestBase.php	This class provides methods specifically for testing Image's field handling.	2
ImageFieldTestBase		abstract class	Drupal\Tests\image\Functional	core/modules/image/tests/src/Functional/ImageFieldTestBase.php	This class provides methods specifically for testing Image's field handling.	10	2
ImageFieldValidateTest		class	Drupal\Tests\image\FunctionalJavascript	core/modules/image/tests/src/FunctionalJavascript/ImageFieldValidateTest.php	Tests validation functions such as min/max resolution.
ImageFieldValidateTest		class	Drupal\Tests\image\Functional	core/modules/image/tests/src/Functional/ImageFieldValidateTest.php	Tests validation functions such as min/max resolution.
ImageFieldWidgetMultipleTest		class	Drupal\Tests\image\FunctionalJavascript	core/modules/image/tests/src/FunctionalJavascript/ImageFieldWidgetMultipleTest.php	Tests the image field widget support multiple upload correctly.
ImageFieldWidgetTest		class	Drupal\Tests\image\Functional	core/modules/image/tests/src/Functional/ImageFieldWidgetTest.php	Tests the image field widget.
ImageFormatter		class	Drupal\image\Plugin\Field\FieldFormatter	core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php	Plugin implementation of the 'image' formatter.	1	1
ImageFormatterBase		abstract class	Drupal\image\Plugin\Field\FieldFormatter	core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatterBase.php	Base class for image file formatters.	3	1
ImageFormatterTest		class	Drupal\Tests\image\Kernel	core/modules/image/tests/src/Kernel/ImageFormatterTest.php	Tests the image field rendering using entity fields of the image field type.
ImageImportTest		class	Drupal\Tests\image\Kernel	core/modules/image/tests/src/Kernel/ImageImportTest.php	Tests config import for Image styles.
ImageInterface		interface	Drupal\Core\Image	core/lib/Drupal/Core/Image/ImageInterface.php	Provides an interface for image objects.	1	14
ImageItem		class	Drupal\image\Plugin\Field\FieldType	core/modules/image/src/Plugin/Field/FieldType/ImageItem.php	Plugin implementation of the 'image' field type.		9
ImageItemTest		class	Drupal\Tests\image\Kernel	core/modules/image/tests/src/Kernel/ImageItemTest.php	Tests using entity fields of the image field type.
ImageLazyLoadController		class	Drupal\image_lazy_load_test\Controller	core/modules/system/tests/modules/image_lazy_load_test/src/Controller/ImageLazyLoadController.php	The ImageLazyLoadController class.
ImageLazyLoadUpdateTest		class	Drupal\Tests\image\Functional	core/modules/image/tests/src/Functional/ImageLazyLoadUpdateTest.php	Tests lazy-load upgrade path.
ImageLoadingAttributeTest		class	Drupal\Tests\system\Functional\Theme	core/modules/system/tests/src/Functional/Theme/ImageLoadingAttributeTest.php	Tests lazy loading for images.

Other projects

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