getForm()
Overview
public struct function getForm(
required string formName
, boolean autoMergeSiteForm = true
, boolean stripPermissionedFields = false
, string permissionContext = ""
, array permissionContextKeys
)
Returns the raw structural definition of the given form
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
| formName | string | Yes | The name of the form to get |
| autoMergeSiteForm | boolean | No (default=true) | Whether or not to automatically merge any matching form definitions in the current active site template |
| stripPermissionedFields | boolean | No (default=false) | Whether or not to strip tabs, fieldsets and fields to which the logged in admin user does not have permission |
| permissionContext | string | No (default="") | When checking for permissioned fields, the permission context to use. See hasPermission(). |
| permissionContextKeys | array | No | When checking for permissioned fields, the permission context keys to use. See hasPermission(). |