You are here

Value.php in Drupal 9

Same filename and directory in other branches
  1. 8 core/lib/Drupal/Core/Render/Element/Value.php

File

core/lib/Drupal/Core/Render/Element/Value.php
View source
<?php

namespace Drupal\Core\Render\Element;


/**
 * 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:
 * - #value: The value of the form element that cannot be edited by the user.
 *
 * Usage Example:
 * @code
 * $form['entity_id'] = array('#type' => 'value', '#value' => $entity_id);
 * @endcode
 *
 * @FormElement("value")
 */
class Value extends FormElement {

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

}

Classes

Namesort descending Description
Value Provides a form element for storage of internal information.