class Hidden

Same name in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/Hidden.php \Drupal\Core\Render\Element\Hidden
  2. 10 core/lib/Drupal/Core/Render/Element/Hidden.php \Drupal\Core\Render\Element\Hidden
  3. 11.x core/lib/Drupal/Core/Render/Element/Hidden.php \Drupal\Core\Render\Element\Hidden

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

Expanded class hierarchy of Hidden

See also

\Drupal\Core\Render\Element\Value

153 string references to 'Hidden'
BaseFieldDefinition::setDisplayConfigurable in core/lib/Drupal/Core/Field/BaseFieldDefinition.php
Sets whether the display for the field can be configured.
block.block.test_block.yml in core/modules/block/tests/modules/block_test/config/install/block.block.test_block.yml
core/modules/block/tests/modules/block_test/config/install/block.block.test_block.yml
block_content_entity_display.yml in core/modules/block_content/migrations/block_content_entity_display.yml
core/modules/block_content/migrations/block_content_entity_display.yml
ClaroEntityDisplayTest::testEntityForm in core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroEntityDisplayTest.php
Copied from parent.
claro_preprocess_views_exposed_form in core/themes/claro/claro.theme
Implements hook_preprocess_HOOK for views_exposed_form.

... See full list

40 #type uses of Hidden
AddFormBase::buildForm in core/modules/media_library/src/Form/AddFormBase.php
Form constructor.
AjaxTestDialogForm::buildForm in core/modules/system/tests/modules/ajax_test/src/Form/AjaxTestDialogForm.php
Form constructor.
BlockForm::form in core/modules/block/src/BlockForm.php
Gets the actual form array to be built.
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.

... See full list

File

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

Namespace

Drupal\Core\Render\Element
View source
class Hidden extends FormElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = get_class($this);
        return [
            '#input' => TRUE,
            '#process' => [
                [
                    $class,
                    'processAjaxForm',
                ],
            ],
            '#pre_render' => [
                [
                    $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, [
            'name',
            'value',
        ]);
        return $element;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes

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