class Value

Same name and namespace in other branches

9 core/lib/Drupal/Core/Render/Element/Value.php \Drupal\Core\Render\Element\Value
8.9.x core/lib/Drupal/Core/Render/Element/Value.php \Drupal\Core\Render\Element\Value
10 core/lib/Drupal/Core/Render/Element/Value.php \Drupal\Core\Render\Element\Value

Provides a form element for storage of internal information.

Unlike \Drupal\Core\Render\Element\Hidden, this information is not sent to the browser in a hidden form field, but only stored in the form array for use in validation and submit processing.

Properties:

@property $value The value of the form element that cannot be edited by the user.

Usage Example:

$form['entity_id'] = [
  '#type' => 'value',
  '#value' => $entity_id,
];

Attributes

#[FormElement('value')]

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\Value implements \Drupal\Core\Render\Element\FormElementBase

Expanded class hierarchy of Value

395 string references to 'Value'

AccessManagerTest::testCheckNamedRouteWithDefaultValue in core/tests/Drupal/Tests/Core/Access/AccessManagerTest.php: Tests the checkNamedRoute with default values.
AccessManagerTest::testCheckNamedRouteWithUpcastedValues in core/tests/Drupal/Tests/Core/Access/AccessManagerTest.php: Tests the checkNamedRoute with upcasted values.
AjaxCommandsTest::testDataCommand in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php: @covers \Drupal\Core\Ajax\DataCommand[[api-linebreak]]
AjaxCommandsTest::testSettingsCommand in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php: @covers \Drupal\Core\Ajax\SettingsCommand[[api-linebreak]]
AttributesTest::providerTestAttributeData in core/tests/Drupal/Tests/Core/Common/AttributesTest.php: Provides data for the Attribute test.

... See full list

56 #type uses of Value

ActionFormBase::form in core/modules/action/src/Form/ActionFormBase.php: Gets the actual form array to be built.
BlockForm::form in core/modules/block/src/BlockForm.php: Gets the actual form array to be built.
BlockInterfaceTest::testBlockInterface in core/modules/block/tests/src/Kernel/BlockInterfaceTest.php: Tests configuration and subsequent form() and build() method calls.
BlockPluginTrait::buildConfigurationForm in core/lib/Drupal/Core/Block/BlockPluginTrait.php: Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements.
BookAdminEditForm::bookAdminTable in core/modules/book/src/Form/BookAdminEditForm.php: Builds the table portion of the form for the book administration page.

... See full list

File

core/lib/Drupal/Core/Render/Element/Value.php, line 24

Namespace

Drupal\Core\Render\Element

View on git.drupalcode.org

View source

class Value extends FormElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#input' => TRUE,
    ];
  }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
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
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.		7
PluginInspectionInterface::getPluginId	public	function	Gets the plugin ID of the plugin instance.		3
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.		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
RenderElementBase::__unset	public	function	Magic method: unsets a property value.
RenderElementBase::__wakeup	public	function
Value::getInfo	public	function	Returns the element properties for this element.	Overrides ElementInterface::getInfo

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

Breadcrumb