Submission
A Submission object represents data that has been saved through a form. That can be a completed submission, a partially saved submission, or a submission that has been marked as spam.
Properties
Type: int|null
The submission ID.
Type: int|null
The form ID this submission belongs to.
Type: verbb\formie\elements\Form|null
The Form this submission belongs to.
Type: int|null
The submission status ID.
Type: string|null
The submission status handle.
Type: int|null
The user ID associated with the submission, when collected.
Type: craft\elements\User|null
The Craft user associated with the submission, when collected.
Type: int|null
The site ID this submission was made on.
Type: array
The saved render snapshot used for field settings and submission output.
Type: string|null
The submitter IP address, when collected.
Type: bool
Whether the submission is incomplete.
Type: bool
Whether the submission has been marked as spam.
Type: string|null
The spam reason, when the submission is marked as spam.
Type: bool|null
Whether validation should only run for the current page.
Type: DateTime|null
The date the submission was created.
Methods
Returns: verbb\formie\elements\Form|null
Returns the submission’s Form.
Returns: array
Returns the form pages for this submission.
Returns: array
Returns the form rows for this submission.
Returns: array
Returns the form fields for this submission.
Returns: verbb\formie\base\FieldInterface|null
Returns a field by handle.
Returns: void
Sets a field value on the submission.
Returns: mixed
Returns only the normalised runtime value for the supplied field key. It takes no projection argument. Text, Email and Phone return strings; Name always returns a NameFieldValue; dates, selected options and relation queries retain their domain semantics.
Returns: mixed
Returns the field value as a string.
Returns: mixed
Returns the natural JSON-safe field value. Primitive fields return scalars; structured fields return explicit named data.
Returns: mixed
Returns the field value prepared for singular reference contexts.
Returns: mixed
Returns the field value prepared for reference-block rendering.
Returns: mixed
Returns the field value prepared for export.
Returns: mixed
Returns the field value prepared for summary views.
Returns: mixed
Returns the field value prepared for an integration field.
Returns: array
Returns all submitted field values as strings.
Returns: array
Returns a handle-keyed map of natural JSON-safe field data. Individual values may be scalars, null or structured arrays.
Returns: array
Returns all submitted field values prepared for export.
Returns: array
Returns all submitted field values prepared for summary views.
Returns: array
Returns element relations found in the submission.
Returns: array|null
Returns payment records associated with the submission.
Returns: array|null
Returns subscription records associated with the submission.