WARNING: You are browsing the documentation for Symfony 2.3 which is not maintained anymore. Consider upgrading your projects to Symfony 5.1.

submit Field Type

2.3 version

Maintained

3.4 4.4 5.1 current 5.2 master

Unmaintained

2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0

submit Field Type
- Inherited Options
- Form Variables

submit Field Type¶

New in version 2.3: The submit type was introduced in Symfony 2.3.

A submit button.

Rendered as	`button` `submit` tag
Inherited options	attr disabled label label_attr translation_domain validation_groups
Parent type	button
Class	`Symfony\Component\Form\Extension\Core\Type\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:

if ($form->get('save')->isClicked()) {
    // ...
}

Inherited Options¶

attr¶

type: array default: 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:

$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:

Twig

{{ form_widget(form.save, { 'label': 'Click me' }) }}

PHP

<?php echo $view['form']->widget($form['save'], array('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:

Twig

{{ form_label(form.name, 'Your name', {
       'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

PHP

echo $view['form']->label(
    $form['name'],
    'Your name',
    array('label_attr' => array('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.

validation_groups¶

type: array default: null

When your form contains multiple submit buttons, you can change the validation group based on the button which was used to submit the form. Imagine a registration form wizard with buttons to go to the previous or the next step:

$form = $this->createFormBuilder($user)
    ->add('previousStep', 'submit', array(
        'validation_groups' => false,
    ))
    ->add('nextStep', 'submit', array(
        'validation_groups' => array('Registration'),
    ))
    ->getForm();

The special false ensures that no validation is performed when the previous step button is clicked. When the second button is clicked, all constraints from the “Registration” are validated.

Form Variables¶

Variable	Type	Usage
clicked	`boolean`	Whether the button is clicked or not.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.