Skip to content

Clarify $formId parameter #1636

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 2 commits into from
Aug 19, 2025
Merged

Clarify $formId parameter #1636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0940849
Clarify parameter
fritzmg Aug 13, 2025
aac36c0
Merge branch 'main' into clarify-formid
fritzmg Aug 13, 2025
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
3 changes: 1 addition & 2 deletions docs/dev/reference/hooks/compileFormFields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ and expects the modified form fields as return value.

2. *string* `$formId`

Alias of the current form. Used in the `value` attribute of the hidden form
field `FORM_SUBMIT`. Don't confuse with `$objForm->id`.
Alias of the current form with the prefix `auto_`. Don't confuse with `$form->id`.

3. *\Contao\Form* `$form`

Expand Down
5 changes: 2 additions & 3 deletions docs/dev/reference/hooks/loadFormField.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ field of the form generator.

2. *string* `$formId`

Alias of the current form. Used in the `value` attribute of the hidden form
field `FORM_SUBMIT`. Don't confuse with `$form->id`.
Alias of the current form with the prefix `auto_`. Don't confuse with `$form->id`.

3. *array* `$formData`

Expand Down Expand Up @@ -55,7 +54,7 @@ class LoadFormFieldListener
{
public function __invoke(Widget $widget, string $formId, array $formData, Form $form): Widget
{
if ('myForm' === $formId) {
if ('myForm' === $form->formID) {
$widget->class.= ' myclass';
}

Expand Down
4 changes: 2 additions & 2 deletions docs/dev/reference/hooks/validateFormField.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ object as return value.

2. *string* `$formId`

Alias of the current form. Used in the `value` attribute of the hidden form field `FORM_SUBMIT`. Do not confuse with `$form->id`.
Alias of the current form with the prefix `auto_`. Don't confuse with `$form->id`.

3. *array* `$formData`

Expand Down Expand Up @@ -52,7 +52,7 @@ class ValidateFormFieldListener
{
public function __invoke(Widget $widget, string $formId, array $formData, Form $form): Widget
{
if ('myform' === $formId && 'mywidget' === $widget->name) {
if ('myform' === $form->formID && 'mywidget' === $widget->name) {
// Do your custom validation and add an error if widget does not validate
// …

Expand Down