Skip to content

[Form] Document the choices option of EnumType #21451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2025
Merged

[Form] Document the choices option of EnumType #21451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions reference/forms/types/enum.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,25 @@ Inherited Options

These options inherit from the :doc:`ChoiceType </reference/forms/types/choice>`:

choices
~~~~~~~

**type**: ``array`` **default**: ``[]``

By default, this field displays all the cases of the related PHP enum. Use this
option to explicitly define which options to display::

use App\Config\TextAlign;
use Symfony\Component\Form\Extension\Core\Type\EnumType;
// ...

$builder->add('alignment', EnumType::class, [
'choices' => [
TextAlign::Left,
TextAlign::Right,
],
]);

.. include:: /reference/forms/types/options/choice_attr.rst.inc

.. include:: /reference/forms/types/options/choice_filter.rst.inc
Expand Down