Is there a convention for the form IDs?
I see that core sometimes uses module_name.form_name and sometimes module_name_form_name.
In my case, I'm using module_name.form_name.
asked Nov 12, 2019 at 20:52
1 Answer
Drupal core doesn't use the dot in the form IDs because, as the documentation for FormInterface::getFormId() says, the form ID should be a unique string that can be a valid PHP function name, since it's used in hook implementation names such as hook_form_FORM_ID_alter().
The form IDs Drupal core uses follow the <module name>_<form name> schema, so you will find form IDs like the following.
- user_admin_settings
- action_admin_manage
- layout_builder_add_block
As long as the form ID is unique, any scheme would work. The convention to prefix an ID with the module name (i.e. the module machine name) has been used from Drupal since many years.
answered Nov 12, 2019 at 21:23
-
Thanks, it seems I had a problem reading the code yesterday :-D drupal.stackexchange.com/questions/288223/… Commented Nov 12, 2019 at 21:46
-
1Sometimes it's not that quick to find a function/method whose documentation helps in understanding how Drupal works. :)) I think this question will help new Drupal developers, as most of them would use a generic ID, not an ID that can also be used as part of a function/method name.– avpaderno ♦Commented Nov 12, 2019 at 22:07
hook_form_FORM_ID_alter()?