checkbox Field Type
Edit this pageWarning: You are browsing the documentation for Symfony 2.0, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
checkbox Field Type
Creates a single input checkbox. This should always be used for a field that has a Boolean value: if the box is checked, the field will be set to true, if the box is unchecked, the value will be set to false.
| Rendered as | input checkbox field |
| Options | |
| Inherited options | |
| Parent type | field |
| Class | CheckboxType |
Example Usage
1 2 3 4
$builder->add('public', 'checkbox', array(
'label' => 'Show this entry publicly?',
'required' => false,
));Field Options
value
type: mixed default: 1
The value that's actually used as the value for the checkbox. This does not affect the value that's set on your object.
Inherited options
These options inherit from the field type:
required
type: Boolean default: true
If true, an HTML5 required attribute will be rendered. The corresponding
label will also render with a required class.
This is superficial and independent from validation. At best, if you let Symfony guess your field type, then the value of this option will be guessed from your validation information.
label
type: string default: The label is "guessed" from the field name
Sets the label that will be used when rendering the field. The label can also be directly set inside the template:
1
{{ form_label(form.name, 'Your name') }}read_only
type: Boolean default: false
If this option is true, the field will be rendered with the disabled
attribute so that the field is not editable.
error_bubbling
type: Boolean default: false
If true, any errors for this field will be passed to the parent field or form. For example, if set to true on a normal field, any errors for that field will be attached to the main form, not to the specific field.
