Document HiddenFormField
authorTim Düsterhus <duesterhus@woltlab.com>
Mon, 10 Oct 2022 14:36:19 +0000 (16:36 +0200)
committerTim Düsterhus <duesterhus@woltlab.com>
Mon, 10 Oct 2022 14:36:19 +0000 (16:36 +0200)
Resolves #287

docs/php/api/form_builder/form_fields.md

index d966b5579b1939a980a2973731d10c01a57d097a..b7730cdf433c7df590668e5296a350d161d105d0 100644 (file)
@@ -95,6 +95,13 @@ The class implements `IAttributeFormField`, `IAutoCompleteFormField`, `IAutoFocu
 `FloatFormField` is an implementation of [AbstractNumericFormField](#abstractnumericformfield) for floating point numbers.
 
 
+### `HiddenFormField`
+
+`HiddenFormField` is a form field without any user-visible UI.
+Even though the form field is invisible to the user, the value can still be modified by the user, e.g. by leveraging the web browsers developer tools.
+The `HiddenFormField` *must not* be used to transfer sensitive information or information that the user should not be able to modify.
+
+
 ### `IconFormField`
 
 `IconFormField` is a form field to select a FontAwesome icon.