summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Pott2018-06-11 18:09:08 (GMT)
committerAlex Pott2018-06-11 18:09:08 (GMT)
commitf283ab5511047dba1cddc33e6821a95509c1e042 (patch)
tree3cdd5d1b0dd7b40566f5a828be5e9310df977dea
parenta3bb9d878f66fbae642b7f1a342745c7602641ea (diff)
Issue #2877828 by msankhala, joachim: FormInterface::getFormId() should state restrictions on the returned ID string
-rw-r--r--core/lib/Drupal/Core/Form/FormInterface.php4
1 files changed, 4 insertions, 0 deletions
diff --git a/core/lib/Drupal/Core/Form/FormInterface.php b/core/lib/Drupal/Core/Form/FormInterface.php
index 2cafbeb..4754a9a 100644
--- a/core/lib/Drupal/Core/Form/FormInterface.php
+++ b/core/lib/Drupal/Core/Form/FormInterface.php
@@ -12,6 +12,10 @@ interface FormInterface {
/**
* Returns a unique string identifying the form.
*
+ * The returned 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().
+ *
* @return string
* The unique string identifying the form.
*/