submit Field Type
Edit this pageWarning: You are browsing the documentation for Symfony 2.4, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
submit Field Type
2.3
The submit type was introduced in Symfony 2.3
A submit button.
| Rendered as | button submit tag |
| Inherited options | |
| Parent type | button |
| Class | SubmitType |
The Submit button has an additional method isClicked() that lets you check whether this button was used to submit the form. This is especially useful when a form has multiple submit buttons:
1 2 3
if ($form->get('save')->isClicked()) {
// ...
}Inherited Options
attr
type: array default: Empty array
If you want to add extra attributes to the HTML representation of the button,
you can use attr option. It's an associative array with HTML attribute
as a key. This can be useful when you need to set a custom class for the button:
1 2 3
$builder->add('save', 'button', array(
'attr' => array('class' => 'save'),
));disabled
type: boolean default: false
If you don't want a user to be able to click a button, you can set the disabled option to true. It will not be possible to submit the form with this button, not even when bypassing the browser and sending a request manually, for example with cURL.
label
type: string default: The label is "guessed" from the field name
Sets the label that will be displayed on the button. The label can also be directly set inside the template:
1
{{ form_widget(form.save, { 'label': 'Click me' }) }}label_attr
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:
1
{{ form_label(form.name, 'Your name', {'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}}) }}translation_domain
type: string default: messages
This is the translation domain that will be used for any labels or options that are rendered for this button.
Form Variables
| Variable | Type | Usage |
|---|---|---|
| clicked | Boolean |
Whether the button is clicked or not. |
