class Hidden in Zircon Profile 8

Provides a form element for an HTML 'hidden' input element.

Specify either #default_value or #value but not both.

Properties:

• #default_value: The initial value of the form element. JavaScript may alter the value prior to submission.
• #value: The value of the form element. The Form API ensures that this value remains unchanged by the browser.

Usage example:

$form['entity_id'] = array(
  '#type' => 'hidden',
  '#value' => $entity_id,
);

Plugin annotation

@FormElement("hidden");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\Core\Render\Element\Hidden

See also

\Drupal\Core\Render\Element\Value

7 string references to 'Hidden'

CommentWidget::formElement in core/modules/comment/src/Plugin/Field/FieldWidget/CommentWidget.php

Returns the form for a single field widget.

core.entity.schema.yml in core/config/schema/core.entity.schema.yml

core/config/schema/core.entity.schema.yml

DisplayPluginBase::optionsSummary in core/modules/views/src/Plugin/views/display/DisplayPluginBase.php

Provides the default summary for options in the views UI.

EntityDisplayFormBase::getExtraFieldVisibilityOptions in core/modules/field_ui/src/Form/EntityDisplayFormBase.php

Returns an array of visibility options for extra fields.

EntityDisplayFormBase::getPluginOptions in core/modules/field_ui/src/Form/EntityDisplayFormBase.php

Returns an array of widget or formatter options for a field.

... See full list

33 #type uses of Hidden

AjaxTestDialogForm::buildForm in core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestDialogForm.php

Form constructor.

BlockListBuilder::buildBlocksForm in core/modules/block/src/BlockListBuilder.php

Builds the main "Blocks" portion of the form.

BookAdminEditForm::bookAdminTable in core/modules/book/src/Form/BookAdminEditForm.php

Builds the table portion of the form for the book administration page.

BookAdminEditForm::bookAdminTableTree in core/modules/book/src/Form/BookAdminEditForm.php

Helps build the main table in the book administration page form.

BookManager::addParentSelectFormElements in core/modules/book/src/BookManager.php

Builds the parent selection form element for the node form or outline tab.

... See full list

File

core/lib/Drupal/Core/Render/Element/Hidden.php, line 32

Contains \Drupal\Core\Render\Element\Hidden.

Namespace

Drupal\Core\Render\Element

class Hidden extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#input' => TRUE,
      '#process' => array(
        array(
          $class,
          'processAjaxForm',
        ),
      ),
      '#pre_render' => array(
        array(
          $class,
          'preRenderHidden',
        ),
      ),
      '#theme' => 'input__hidden',
    );
  }

  /**
   * Prepares a #type 'hidden' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #name, #value, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderHidden($element) {
    $element['#attributes']['type'] = 'hidden';
    Element::setAttributes($element, array(
      'name',
      'value',
    ));
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
Hidden::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo	1
Hidden::preRenderHidden	public static	function	Prepares a #type 'hidden' render element for input.html.twig.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.