class Item

Same name and namespace in other branches

9 core/modules/aggregator/src/Entity/Item.php \Drupal\aggregator\Entity\Item
9 core/lib/Drupal/Core/Render/Element/Item.php \Drupal\Core\Render\Element\Item
8.9.x core/modules/aggregator/src/Entity/Item.php \Drupal\aggregator\Entity\Item
8.9.x core/lib/Drupal/Core/Render/Element/Item.php \Drupal\Core\Render\Element\Item
10 core/lib/Drupal/Core/Render/Element/Item.php \Drupal\Core\Render\Element\Item

Provides a display-only form element with an optional title and description.

Note: since this is a read-only field, setting the #required property will do nothing except theme the form element to look as if it were actually required (i.e. by placing a red star next to the #title).

Attributes

#[FormElement('item')]

Hierarchy

class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
      - class \Drupal\Core\Render\Element\Item implements \Drupal\Core\Render\Element\FormElementBase

Expanded class hierarchy of Item

13 string references to 'Item'

config_test.schema.yml in core/modules/config/tests/config_test/config/schema/config_test.schema.yml: core/modules/config/tests/config_test/config/schema/config_test.schema.yml
ContentTranslationHandler::addTranslatabilityClue in core/modules/content_translation/src/ContentTranslationHandler.php: Adds a clue about the form element translatability.
FormBuilder::handleInputElement in core/lib/Drupal/Core/Form/FormBuilder.php: Adds the #name and #value properties of an input element before rendering.
JsonApiDocumentTopLevelNormalizer::normalizeOmissionsLinks in core/modules/jsonapi/src/Normalizer/JsonApiDocumentTopLevelNormalizer.php: Normalizes omitted data into a set of omission links.
LinksetController::toLinkTargetObjects in core/modules/system/src/Controller/LinksetController.php: Encode a menu tree as link items and capture any cacheability metadata.

... See full list

53 #type uses of Item

AddFormBase::buildEntityFormElement in core/modules/media_library/src/Form/AddFormBase.php: Builds the sub-form for setting required fields on a new media item.
AddHandler::buildForm in core/modules/views_ui/src/Form/Ajax/AddHandler.php: Form constructor.
AjaxTestImageEffect::ajaxCallback in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php: AJAX callback.
AjaxTestImageEffect::buildConfigurationForm in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php: Form constructor.
ArgumentPluginBase::buildOptionsForm in core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php: Provide a form to edit options for this plugin.

... See full list

File

core/lib/Drupal/Core/Render/Element/Item.php, line 14

Namespace

Drupal\Core\Render\Element

View on git.drupalcode.org

View source

class Item extends FormElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      // Forms that show author fields to both anonymous and authenticated users
      // need to dynamically switch between #type 'textfield' and #type 'item'
      // to automatically take over the authenticated user's information.
      // Therefore, we allow #type 'item' to receive input, which is internally
      // assigned by Form API based on the #default_value or #value properties.
'#input' => TRUE,
      '#markup' => '',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Overriden Title	Overrides
DependencySerializationTrait::$_entityStorages		protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds		protected	property	An array of service IDs keyed by property name used for serialization.
FormElementBase::processAutocomplete		public static	function	Adds autocomplete functionality to elements.		1
FormElementBase::processPattern		public static	function	Render API callback: Handles the #pattern form element property.		1
FormElementBase::validatePattern		public static	function	Render API callback: Handles the #pattern form element property..		1
FormElementBase::valueCallback		public static	function	Determines how user input is mapped to an element's #value property.	Overrides FormElementInterface::valueCallback	17
Item::getInfo		public	function	Returns the element properties for this element.	Overrides ElementInterface::getInfo
MessengerTrait::$messenger		protected	property	The messenger.		25
MessengerTrait::messenger		public	function	Gets the messenger.		25
MessengerTrait::setMessenger		public	function	Sets the messenger.
PluginBase::$configuration		protected	property	Configuration information passed into the plugin.		1
PluginBase::$pluginDefinition		protected	property	The plugin implementation definition.		1
PluginBase::$pluginId		protected	property	The plugin ID.
PluginBase::DERIVATIVE_SEPARATOR			constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId		public	function	Gets the base_plugin_id of the plugin instance.	Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId		public	function	Gets the derivative_id of the plugin instance.	Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition		public	function	Gets the definition of the plugin implementation.	Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId		public	function	Gets the plugin ID of the plugin instance.	Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	Deprecated	public	function	Determines if the plugin is configurable.
RenderElementBase::$renderParent		protected	property	The parent element.
RenderElementBase::$renderParentName		protected	property	The parent key.
RenderElementBase::$storage		protected	property	The storage.
RenderElementBase::addChild		public	function	Adds a child render element.	Overrides ElementInterface::addChild
RenderElementBase::changeType		public	function	Change the type of the element.	Overrides ElementInterface::changeType
RenderElementBase::create		public static	function	Creates an instance of the plugin.	Overrides ContainerFactoryPluginInterface::create	2
RenderElementBase::createChild		public	function	Creates a render object and attaches it to the current render object.	Overrides ElementInterface::createChild
RenderElementBase::elementInfoManager		protected	function	Returns the element info manager.
RenderElementBase::getChild		public	function	Gets a child.	Overrides ElementInterface::getChild
RenderElementBase::getChildren		public	function	Returns child elements.	Overrides ElementInterface::getChildren
RenderElementBase::initializeInternalStorage		public	function	Initialize storage.	Overrides ElementInterface::initializeInternalStorage
RenderElementBase::preRenderAjaxForm		public static	function	Adds Ajax information about an element to communicate with JavaScript.		2
RenderElementBase::preRenderGroup		public static	function	Adds members of this group as actual elements for rendering.		2
RenderElementBase::processAjaxForm		public static	function	Form element processing handler for the #ajax form property.		3
RenderElementBase::processGroup		public static	function	Arranges elements into groups.		2
RenderElementBase::removeChild		public	function	Removes a child.	Overrides ElementInterface::removeChild
RenderElementBase::setAttributes		public static	function	Sets a form element's class attribute.	Overrides ElementInterface::setAttributes	2
RenderElementBase::setType		protected	function	Set type on initialize.		1
RenderElementBase::toRenderable		public	function	Returns a render array.	Overrides ElementInterface::toRenderable
RenderElementBase::__construct		public	function	Constructs a new render element object.	Overrides PluginBase::__construct	6
RenderElementBase::__get		public	function	Magic method: gets a property value.
RenderElementBase::__isset		public	function	Magic method: checks if a property value is set.
RenderElementBase::__set		public	function	Magic method: Sets a property value.
RenderElementBase::__sleep		public	function		Overrides DependencySerializationTrait::__sleep
RenderElementBase::__unset		public	function	Magic method: unsets a property value.
RenderElementBase::__wakeup		public	function		Overrides DependencySerializationTrait::__wakeup
StringTranslationTrait::$stringTranslation		protected	property	The string translation service.		3
StringTranslationTrait::formatPlural		protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals		protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation		protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation		public	function	Sets the string translation service to use.		2
StringTranslationTrait::t		protected	function	Translates a string to the current language or to a given language.		1

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

Breadcrumb