ActionView::Helpers::FormHelper

hidden_field

API docs (Rails 8.1.4.1) ↗

def hidden_field(object_name, method, options = {})

Description

Creates an <input> with type="hidden" for a model attribute.

Arguments

Changing a value updates the ERB and HTML.

object_name:user

method:token

options= {}

Common options

Rails handles these options the same way in every helper. Options the HTML spec does not allow on the <input type="hidden">, and ones this site considers rarely used, are not listed here.

Shared by `…_field` helpers

:value = the object's value

"abc123"

Sets value to the given value as is. Defaults to the object's value. If there is no object, or the value is nil, value is omitted.

Shared by form helpers

:name = generated

"q"

Replaces the generated name with the given value. nil omits name.

:id = generated

nil

Replaces the generated id with the given value. nil omits id.

Shared by all helpers

:disabled

truefalse

true adds disabled="disabled"; false omits it. The same goes for every HTML attribute in Rails' list (BOOLEAN_ATTRIBUTES), such as readonly, required and autofocus: any value other than false or nil adds it as attr="attr".

:class

{active: true, hidden: false}

A hash gives the keys whose values are not false or nil, joined with spaces. An array gives its elements joined with spaces, after removing nil, false and empty strings (including whitespace-only strings).

:data

{controller: "tags", tags_suggestions_value: ["ruby", "rails"]}

A hash adds data-* attributes, with _ in the keys converted to -. Array and hash values are converted to JSON strings.

Any other options become HTML attributes of the <input type="hidden">; those with a nil value are left out.

ERB

Changes from the previous output: Added Removed Changed

HTML

Form submission

Form data

name	value

Request body

Content-Type:

params