Skip to content

[Form] Document using TranslatableMessage in form help #15527

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
Jul 16, 2021
Merged

[Form] Document using TranslatableMessage in form help #15527

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
22 changes: 18 additions & 4 deletions reference/forms/types/options/help.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
help
~~~~

**type**: ``string`` **default**: null
**type**: ``string`` or ``TranslatableMessage`` **default**: null

Allows you to define a help message for the form field, which by default is
rendered below the field::

$builder->add('zipCode', null, [
'help' => 'The ZIP/Postal code for your credit card\'s billing address.',
]);
use Symfony\Component\Translation\TranslatableMessage;

$builder
->add('zipCode', null, [
'help' => 'The ZIP/Postal code for your credit card\'s billing address.',
])

// ...

->add('status', null, [
'help' => new TranslatableMessage('order.status', ['%order_id%' => $order->getId()], 'store'),
])
;

.. versionadded:: 5.4

Support for passing ``TranslatableMessage`` objects was introduced in Symfony 5.4.