radio Field Type

Edit this page

Warning: You are browsing the documentation for Symfony 2.4, which is no longer maintained.

Read the updated version of this page for Symfony 6.1 (the current stable version).

radio Field Type

Creates a single radio button. If the radio button is selected, the field will be set to the specified value. Radio buttons cannot be unchecked - the value only changes when another radio button with the same name gets checked.

The radio type isn't usually used directly. More commonly it's used internally by other types such as choice. If you want to have a Boolean field, use checkbox.

Rendered as input radio field
Inherited options from the checkbox type: - value from the form type: - data - disabled - empty_data - error_bubbling - error_mapping - label - label_attr - mapped - read_only - required
Parent type checkbox
Class RadioType

Inherited Options

These options inherit from the checkbox type:


type: mixed default: 1

The value that's actually used as the value for the checkbox or radio button. This does not affect the value that's set on your object.


To make a checkbox or radio button checked by default, use the data option.

These options inherit from the form type:


type: mixed default: Defaults to field of the underlying object (if there is one)

When you create a form, each field initially displays the value of the corresponding property of the form's domain object (if an object is bound to the form). If you want to override the initial value for the form or just an individual field, you can set it in the data option:

$builder->add('token', 'hidden', array(
    'data' => 'abcdef',


The default values for form fields are taken directly from the
underlying data structure (e.g. an entity or an array).
The data option overrides this default value.


type: boolean default: false

If you don't want a user to modify the value of a field, you can set the disabled option to true. Any submitted value will be ignored.


type: string default: mixed

This option determines what value the field will return when the empty_value choice is selected. In the checkbox and the radio type, the value of empty_data is overriden by the value returned by the data transformer (see How to Use Data Transformers).


type: Boolean default: false unless the form is compound

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.


type: array default: empty

This option allows you to modify the target of a validation error.

Imagine you have a custom method named matchingCityAndZipCode that validates whether the city and zip code match. Unfortunately, there is no "matchingCityAndZipCode" field in your form, so all that Symfony can do is display the error on top of the form.

With customized error mapping, you can do better: map the error to the city field so that it displays above it:

public function setDefaultOptions(OptionsResolverInterface $resolver)
        'error_mapping' => array(
            'matchingCityAndZipCode' => 'city',

Here are the rules for the left and the right side of the mapping:

  • The left side contains property paths;
  • If the violation is generated on a property or method of a class, its path is simply propertyName;
  • If the violation is generated on an entry of an array or ArrayAccess object, the property path is [indexName];
  • You can construct nested property paths by concatenating them, separating properties by dots. For example: addresses[work].matchingCityAndZipCode;
  • The left side of the error mapping also accepts a dot ., which refers to the field itself. That means that any error added to the field is added to the given nested field instead;
  • The right side contains simply the names of fields in the form.


type: string default: The label is "guessed" from the field name

Sets the label that will be used when rendering the field. Setting to false will suppress the label. The label can also be directly set inside the template:

  • Twig
  • PHP
{{ form_label(, 'Your name') }}


type: array default: array()

Sets the HTML attributes for the <label> element, which will be used when rendering the label for the field. It's an associative array with HTML attribute as a key. This attributes can also be directly set inside the template:

  • Twig
  • PHP
{{ form_label(, 'Your name', {'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}}) }}


type: boolean default: true

If you wish the field to be ignored when reading or writing to the object, you can set the mapped option to false.


type: Boolean default: false

If this option is true, the field will be rendered with the readonly attribute so that the field is not editable.


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.


The required option also affects how empty data for each field is handled. For more details, see the empty_data option.

Form Variables

Variable Type Usage
checked Boolean Whether or not the current input is checked.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.