Form
A Form object represents the whole form: its settings, pages, fields, notifications and render context. When you work with a form in Twig or PHP, this is usually the main object you are dealing with.
Properties
Type: int|null
The form ID.
Type: string|null
The form title.
Type: string|null
The form handle.
Encoded JSON used by Formie’s front-end form handling.
Type: verbb\formie\models\SubmissionStatus|null
The default status for new submissions on this form.
Type: verbb\formie\models\FormTemplate|null
The form template assigned to the form, if one is set.
Type: int|null
The ID of the form group this form belongs to in the control panel, if any.
Methods
Returns: array
Returns the form’s Page objects.
Returns: bool
Returns whether the form has more than one page.
Returns: verbb\formie\models\FieldLayoutPage|null
Returns the current page for multi-page form handling.
Returns: verbb\formie\models\FieldLayoutPage|null
Returns the previous page, if one exists.
Returns: verbb\formie\models\FieldLayoutPage|null
Returns the next page, if one exists.
Returns: int
Returns the current page’s zero-based index.
Returns: bool
Returns whether the current page is the first page.
Returns: bool
Returns whether the current page is the last page.
Returns: array
Returns all Field objects on the form.
Returns: verbb\formie\base\FieldInterface|null
Returns a field by its handle.
Returns: array|null
Returns all Notification objects attached to the form.
Returns: array
Returns the enabled notifications attached to the form.
Returns: string
Returns the URL Formie will redirect to after a successful submission, when applicable.
Returns: verbb\formie\elements\Submission|null
Returns the submission currently associated with the form render, when available.