Formie provides a multitude of events for extending its functionality. Modules and plugins can register event listeners, typically in their init() methods, to modify Formie’s behavior.
modifyFormCaptchas event #The event that is triggered to allow modification of captchas for a specific form.
use verbb\formie\elements\Form;
use verbb\formie\events\ModifyFormCaptchasEvent;
use yii\base\Event;
Event::on(Form::class, Form::EVENT_MODIFY_FORM_CAPTCHAS, function(ModifyFormCaptchasEvent $event) {
$captchas = $event->captchas;
// ...
});
beforeSaveForm event #The event that is triggered before a form is saved. You can set $event->isValid to false to prevent saving.
use verbb\formie\elements\Form;
use yii\base\Event;
Event::on(Form::class, Form::EVENT_BEFORE_SAVE, function(Event $event) {
$form = $event->sender;
$event->isValid = false;
});
afterSaveForm event #The event that is triggered after a form is saved.
use verbb\formie\elements\Form;
use yii\base\Event;
Event::on(Form::class, Form::EVENT_AFTER_SAVE, function(Event $event) {
$form = $event->sender;
});
beforeDeleteForm event #The event that is triggered before a form is deleted.
The isValid event property can be set to false to prevent the the deletion from proceeding.
use verbb\formie\elements\Form;
use yii\base\Event;
Event::on(Form::class, Form::EVENT_BEFORE_DELETE, function(Event $event) {
$form = $event->sender;
$event->isValid = false;
});
afterDeleteForm event #The event that is triggered after a form is deleted.
use verbb\formie\elements\Form;
use yii\base\Event;
Event::on(Form::class, Form::EVENT_AFTER_DELETE, function(Event $event) {
$form = $event->sender;
});
modifyRenderForm event #The event that is triggered when a form is rendered using the craft.formie.renderForm() function.
use verbb\formie\events\ModifyRenderEvent;
use verbb\formie\services\Rendering;
use yii\base\Event;
Event::on(Rendering::class, Rendering::EVENT_MODIFY_RENDER_FORM, function(ModifyRenderEvent $event) {
$html = $event->html;
// ...
});
modifyRenderPage event #The event that is triggered when a form page is rendered using the craft.formie.renderPage() function.
use verbb\formie\events\ModifyRenderEvent;
use verbb\formie\services\Rendering;
use yii\base\Event;
Event::on(Rendering::class, Rendering::EVENT_MODIFY_RENDER_PAGE, function(ModifyRenderEvent $event) {
$html = $event->html;
// ...
});
modifyRenderField event #The event that is triggered when a form field is rendered using the craft.formie.renderField() function.
use verbb\formie\events\ModifyRenderEvent;
use verbb\formie\services\Rendering;
use yii\base\Event;
Event::on(Rendering::class, Rendering::EVENT_MODIFY_RENDER_FIELD, function(ModifyRenderEvent $event) {
$html = $event->html;
// ...
});
defineSubmissionRules event #The event that is triggered to modify or define additional validation rules for submissions.
use verbb\formie\elements\Submission;
use verbb\formie\events\SubmissionRulesEvent;
use yii\base\Event;
Event::on(Submission::class, Submission::EVENT_DEFINE_RULES, function(SubmissionRulesEvent $event) {
$submission = $event->submission;
$rules = $event->rules;
// ...
// Add a required field for field with handle `emailAddress`
$event->rules[] = [['field:emailAddress'], 'required'];
});
beforeSaveSubmission event #The event that is triggered before a submission is saved. For multi-page forms, this event will occur on each page submission, as the submission is saved in its incomplete state.
You can set $event->isValid to false to prevent saving.
use verbb\formie\elements\Submission;
use yii\base\Event;
Event::on(Submission::class, Submission::EVENT_BEFORE_SAVE, function(Event $event) {
$submission = $event->sender;
$event->isValid = false;
});
afterSaveSubmission event #The event that is triggered after a submission is saved. For multi-page forms, this event will occur on each page submission, as the submission is saved in its incomplete state.
Do note the difference between this event and afterSubmission.
use verbb\formie\elements\Submission;
use yii\base\Event;
Event::on(Submission::class, Submission::EVENT_AFTER_SAVE, function(Event $event) {
$submission = $event->sender;
});
beforeSubmission event #The event that is triggered before a submission has been completed. For multi-page forms, this is triggered when the final page has been reached and is being submitted.
use verbb\formie\events\SubmissionEvent;
use verbb\formie\services\Submissions;
use yii\base\Event;
Event::on(Submissions::class, Submissions::EVENT_BEFORE_SUBMISSION, function(SubmissionEvent $event) {
$submission = $event->submission;
// ...
});
beforeIncompleteSubmission event #The event that is triggered before a submission has been made, but is incomplete. This is primarily for multi-page forms, where this event is fired on each submission of each page, except the final page.
use verbb\formie\events\SubmissionEvent;
use verbb\formie\services\Submissions;
use yii\base\Event;
Event::on(Submissions::class, Submissions::EVENT_BEFORE_INCOMPLETE_SUBMISSION, function(SubmissionEvent $event) {
$submission = $event->submission;
// ...
});
afterSubmission event #The event that is triggered after a submission has been completed, whether successful or not. For multi-page forms, this is triggered when the final page has been reached and submitted.
You should always check $event->success if you want to ensure your event only triggers on submissions that have been successful.
use verbb\formie\events\SubmissionEvent;
use verbb\formie\services\Submissions;
use yii\base\Event;
Event::on(Submissions::class, Submissions::EVENT_AFTER_SUBMISSION, function(SubmissionEvent $event) {
$submission = $event->submission;
$success = $event->success;
// ...
});
afterIncompleteSubmission event #The event that is triggered after a submission has been made, whether successful or not, not while the submission is incomplete. This is primarily for multi-page forms, where this event is fired on each submission of each page, except the final page.
You should always check $event->success if you want to ensure your event only triggers on submissions that have been successful.
use verbb\formie\events\SubmissionEvent;
use verbb\formie\services\Submissions;
use yii\base\Event;
Event::on(Submissions::class, Submissions::EVENT_AFTER_INCOMPLETE_SUBMISSION, function(SubmissionEvent $event) {
$submission = $event->submission;
$success = $event->success;
// ...
});
beforeDeleteSubmission event #The event that is triggered before a submission is deleted.
The isValid event property can be set to false to prevent the the deletion from proceeding.
use verbb\formie\elements\Submission;
use yii\base\Event;
Event::on(Submission::class, Submission::EVENT_BEFORE_DELETE, function(Event $event) {
$submission = $event->sender;
$event->isValid = false;
});
afterDeleteSubmission event #The event that is triggered after a submission is deleted.
use verbb\formie\elements\Submission;
use yii\base\Event;
Event::on(Submission::class, Submission::EVENT_AFTER_DELETE, function(Event $event) {
$submission = $event->sender;
});
beforeSendNotification event #The event that is triggered before an email notification is sent.
The isValid event property can be set to false to prevent the notification from proceeding.
use verbb\formie\events\SendNotificationEvent;
use verbb\formie\services\Submissions;
use yii\base\Event;
Event::on(Submissions::class, Submissions::EVENT_BEFORE_SEND_NOTIFICATION, function(SendNotificationEvent $event) {
$submissionId = $event->submissionId;
$notificationId = $event->notificationId;
// ...
});
beforeTriggerIntegration event #The event that is triggered before an integration is triggered.
The isValid event property can be set to false to prevent the integration from proceeding.
use verbb\formie\events\SendNotificationEvent;
use verbb\formie\services\Submissions;
use yii\base\Event;
Event::on(Submissions::class, Submissions::EVENT_BEFORE_TRIGGER_INTEGRATION, function(SendNotificationEvent $event) {
$submissionId = $event->submissionId;
$integration = $event->integration;
// ...
});
modifyFieldExport event #The event that is triggered after a field's value has been prepped for export.
Modify the fieldValue event property to set the value used in exports.
use verbb\formie\elements\exporters\SubmissionExport;
use verbb\formie\events\ModifyFieldExportEvent;
use yii\base\Event;
Event::on(SubmissionExport::class, SubmissionExport::EVENT_MODIFY_FIELD_EXPORT, function(ModifyFieldExportEvent $event) {
$field = $event->field;
$value = $event->value;
$element = $event->element;
$fieldValue = $event->fieldValue;
// ...
});
modifyFieldValueForIntegration event #The event that is triggered after a field's value has been prepped for all integrations.
Modify the value event property to set the value used by integrations.
use verbb\formie\elements\Submission;
use verbb\formie\events\ModifyFieldValueForIntegrationEvent;
use yii\base\Event;
Event::on(Submission::class, Submission::EVENT_MODIFY_FIELD_VALUE_FOR_INTEGRATION, function(ModifyFieldValueForIntegrationEvent $event) {
$field = $event->field;
$value = $event->value;
$submission = $event->submission;
// ...
});
beforeSubmissionRequest event #The event that is triggered before a submission is validated. This is triggered on the controller action endpoint, so should primarily be used for modification of the submission before validation, or any other use-case that needs to occur in the controller.
use verbb\formie\controllers\SubmissionsController;
use verbb\formie\events\SubmissionEvent;
use yii\base\Event;
Event::on(SubmissionsController::class, SubmissionsController::EVENT_BEFORE_SUBMISSION_REQUEST, function(SubmissionEvent $event) {
$submission = $event->submission;
$success = $event->success;
// ...
});
afterSubmissionRequest event #The event that is triggered after a submission has been completed, whether successful or not. This is triggered on the controller action endpoint, so should primarily be used for redirection hijacking, or any other use-case that needs to occur in the controller.
use verbb\formie\controllers\SubmissionsController;
use verbb\formie\events\SubmissionEvent;
use yii\base\Event;
Event::on(SubmissionsController::class, SubmissionsController::EVENT_AFTER_SUBMISSION_REQUEST, function(SubmissionEvent $event) {
$submission = $event->submission;
$success = $event->success;
// ...
});
beforeMarkedAsSpam event #The event that is triggered before the submission which has been marked as spam, is marked as spam. This event fires only after the submission has already been marked as spam.
The isValid event property can be set to false to prevent the submission from being marked as spam.
use verbb\formie\elements\Submission;
use verbb\formie\events\SubmissionMarkedAsSpamEvent;
use yii\base\Event;
Event::on(Submission::class, Submission::EVENT_BEFORE_MARKED_AS_SPAM, function(SubmissionMarkedAsSpamEvent $event) {
$submission = $event->submission;
$isNew = $event->isNew;
$isValid = $event->isValid;
// ...
});
beforeSpamCheck event #The event that is triggered before spam checks are carried out. These are not captcha checks, but Formie's spam checking like keywords.
You can use $event->submission->isSpam to modify the behaviour of whether Formie identifies the submission as spam or not.
use verbb\formie\events\SubmissionSpamCheckEvent;
use verbb\formie\services\Submissions;
use yii\base\Event;
Event::on(Submissions::class, Submissions::EVENT_BEFORE_SPAM_CHECK, function(SubmissionSpamCheckEvent $event) {
$submission = $event->submission;
// Flag this submission as spam
$event->submission->isSpam = true;
});
afterSpamCheck event #The event that is triggered after spam checks have been carried out. These are not captcha checks, but Formie's spam checking like keywords.
You can use $event->submission->isSpam to modify the behaviour of whether Formie identifies the submission as spam or not.
use verbb\formie\events\SubmissionSpamCheckEvent;
use verbb\formie\services\Submissions;
use yii\base\Event;
Event::on(Submissions::class, Submissions::EVENT_AFTER_SPAM_CHECK, function(SubmissionSpamCheckEvent $event) {
$submission = $event->submission;
// Flag this submission as spam
$event->submission->isSpam = true;
});
registerFields event #The event that is triggered for registration of additional fields.
use verbb\formie\events\RegisterFieldsEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_REGISTER_FIELDS, function(RegisterFieldsEvent $event) {
$event->fields[] = MyField::class;
// ...
});
registerLabelPositions event #The event that is triggered for registration of additional label positions.
use verbb\formie\events\RegisterFieldOptionsEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_REGISTER_LABEL_POSITIONS, function(RegisterFieldOptionsEvent $event) {
$fields = $event->fields;
$options = $event->options;
// ...
});
registerInstructionsPositions event #The event that is triggered for registration of additional instructions positions.
use verbb\formie\events\RegisterFieldOptionsEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_REGISTER_INSTRUCTIONS_POSITIONS, function(RegisterFieldOptionsEvent $event) {
$fields = $event->fields;
$options = $event->options;
// ...
});
modifyExistingFields event #The event that is triggered to allow modifying of available existing fields to select from.
use verbb\formie\events\ModifyExistingFieldsEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_MODIFY_EXISTING_FIELDS, function(ModifyExistingFieldsEvent $event) {
$fields = $event->fields;
// ...
});
modifyFieldConfig event #The event that is triggered to allow modification of the config for fields, used in the form builder.
use verbb\formie\events\ModifyFieldConfigEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_MODIFY_FIELD_CONFIG, function(ModifyFieldConfigEvent $event) {
$config = $event->config;
// ...
});
modifyFieldRowConfig event #The event that is triggered to allow modification of the config for rows, used in the form builder.
use verbb\formie\events\ModifyFieldRowConfigEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_MODIFY_FIELD_ROW_CONFIG, function(ModifyFieldRowConfigEvent $event) {
$config = $event->config;
// ...
});
beforeSaveFieldRow event #The event that is triggered before the field's row is saved.
use verbb\formie\events\FieldRowEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_BEFORE_SAVE_FIELD_ROW, function(FieldRowEvent $event) {
$row = $event->row;
$isNew = $event->isNew;
// ...
});
afterSaveFieldRow event #The event that is triggered after the field's row is saved.
use verbb\formie\events\FieldRowEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_AFTER_SAVE_FIELD_ROW, function(FieldRowEvent $event) {
$row = $event->row;
$isNew = $event->isNew;
// ...
});
beforeSaveFieldPage event #The event that is triggered before the field's page is saved.
use verbb\formie\events\FieldPageEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_BEFORE_SAVE_FIELD_PAGE, function(FieldPageEvent $event) {
$page = $event->page;
$isNew = $event->isNew;
// ...
});
afterSaveFieldPage event #The event that is triggered after the field's page is saved.
use verbb\formie\events\FieldPageEvent;
use verbb\formie\services\Fields;
use yii\base\Event;
Event::on(Fields::class, Fields::EVENT_AFTER_SAVE_FIELD_PAGE, function(FieldPageEvent $event) {
$page = $event->page;
$isNew = $event->isNew;
// ...
});
modifyDateFormat event #The event that is triggered to modify the Date Format for the field.
use verbb\formie\events\ModifyDateTimeFormatEvent;
use verbb\formie\fields\formfields\Date;
use yii\base\Event;
Event::on(Date::class, Date::EVENT_MODIFY_DATE_FORMAT, function(ModifyDateTimeFormatEvent $event) {
$event->dateFormat = 'Y-m-d';
});
modifyTimeFormat event #The event that is triggered to modify the Time Format for the field.
use verbb\formie\events\ModifyDateTimeFormatEvent;
use verbb\formie\fields\formfields\Date;
use yii\base\Event;
Event::on(Date::class, Date::EVENT_MODIFY_TIME_FORMAT, function(ModifyDateTimeFormatEvent $event) {
$event->timeFormat = 'H:i';
});
modifyElementFieldQuery event #The event that is triggered to modify the query for element fields, for when rendering options on the front-end.
use verbb\formie\events\ModifyElementFieldQueryEvent;
use verbb\formie\fields\formfields\Entries;
use yii\base\Event;
Event::on(Entries::class, Entries::EVENT_MODIFY_ELEMENT_QUERY, function(ModifyElementFieldQueryEvent $event) {
$query = $event->query;
$field = $event->field;
// ...
});
modifyPurifierConfig event #The event that is triggered to modify the HTML Purifier config.
use verbb\formie\events\ModifyPurifierConfigEvent;
use verbb\formie\fields\formfields\Html;
use HTMLPurifier_AttrDef_Text;
use yii\base\Event;
Event::on(Html::class, Html::EVENT_MODIFY_PURIFIER_CONFIG, function(ModifyPurifierConfigEvent $event) {
$event->config->getHTMLDefinition(true)->addAttribute('span', 'data-type', new HTMLPurifier_AttrDef_Text());
});
modifyPrefixOptions event #The event that is triggered to modify the Prefix options for the field.
use verbb\formie\events\ModifyNamePrefixOptionsEvent;
use verbb\formie\fields\formfields\Name;
use yii\base\Event;
Event::on(Name::class, Name::EVENT_MODIFY_PREFIX_OPTIONS, function(ModifyNamePrefixOptionsEvent $event) {
$event->options[] = ['label' => Craft::t('formie', 'Mx.'), 'value' => 'mx'];
});
modifyPhoneCountries event #The event that is triggered to modify the available countries the phone field has access to.
use verbb\formie\events\ModifyPhoneCountriesEvent;
use verbb\formie\services\Phone;
use yii\base\Event;
Event::on(Phone::class, Phone::EVENT_MODIFY_PHONE_COUNTRIES, function(ModifyPhoneCountriesEvent $event) {
$countries = $event->countries;
// ...
});
registerPredefinedOptions event #The event that is triggered for registering predefined options for Dropdown, Radio Button and Checkboxes fields.
use verbb\formie\events\RegisterPredefinedOptionsEvent;
use verbb\formie\services\PredefinedOptions;
use yii\base\Event;
Event::on(PredefinedOptions::class, PredefinedOptions::EVENT_REGISTER_PREDEFINED_OPTIONS, function(RegisterPredefinedOptionsEvent $event) {
$event->options[] = CustomOptions::class;
});
beforeSaveSyncedField event #The event that is triggered before a synced field is saved.
use verbb\formie\events\SyncedFieldEvent;
use verbb\formie\services\Syncs;
use yii\base\Event;
Event::on(Syncs::class, Syncs::EVENT_BEFORE_SAVE_SYNCED_FIELD, function(SyncedFieldEvent $event) {
$field = $event->field;
// ...
});
afterSaveSyncedField event #The event that is triggered after a synced field is saved.
use verbb\formie\events\SyncedFieldEvent;
use verbb\formie\services\Syncs;
use yii\base\Event;
Event::on(Syncs::class, Syncs::EVENT_AFTER_SAVE_SYNCED_FIELD, function(SyncedFieldEvent $event) {
$field = $event->field;
// ...
});
beforeSaveStatus event #The event that is triggered before a submission status is saved.
use verbb\formie\events\StatusEvent;
use verbb\formie\services\Statuses;
use yii\base\Event;
Event::on(Statuses::class, Statuses::EVENT_BEFORE_SAVE_STATUS, function(StatusEvent $event) {
$status = $event->status;
$isNew = $event->isNew;
// ...
});
afterSaveStatus event #The event that is triggered after a submission status is saved.
use verbb\formie\events\StatusEvent;
use verbb\formie\services\Statuses;
use yii\base\Event;
Event::on(Statuses::class, Statuses::EVENT_AFTER_SAVE_STATUS, function(StatusEvent $event) {
$status = $event->status;
$isNew = $event->isNew;
// ...
});
beforeDeleteStatus event #The event that is triggered before a submission status is deleted.
use verbb\formie\events\StatusEvent;
use verbb\formie\services\Statuses;
use yii\base\Event;
Event::on(Statuses::class, Statuses::EVENT_BEFORE_DELETE_STATUS, function(StatusEvent $event) {
$status = $event->status;
// ...
});
beforeApplyStatusDelete event #The event that is triggered before a submission status is deleted.
use verbb\formie\events\StatusEvent;
use verbb\formie\services\Statuses;
use yii\base\Event;
Event::on(Statuses::class, Statuses::EVENT_BEFORE_APPLY_STATUS_DELETE, function(StatusEvent $event) {
$status = $event->status;
// ...
});
afterDeleteStatus event #The event that is triggered after a submission status is deleted.
use verbb\formie\events\StatusEvent;
use verbb\formie\services\Statuses;
use yii\base\Event;
Event::on(Statuses::class, Statuses::EVENT_AFTER_DELETE_STATUS, function(StatusEvent $event) {
$status = $event->status;
// ...
});
beforeSaveNotification event #The event that is triggered before an email notification is saved.
use verbb\formie\events\NotificationEvent;
use verbb\formie\services\Notifications;
use yii\base\Event;
Event::on(Notifications::class, Notifications::EVENT_BEFORE_SAVE_NOTIFICATION, function(NotificationEvent $event) {
$notification = $event->notification;
$isNew = $event->isNew;
// ...
});
afterSaveNotification event #The event that is triggered after an email notification is saved.
use verbb\formie\events\NotificationEvent;
use verbb\formie\services\Notifications;
use yii\base\Event;
Event::on(Notifications::class, Notifications::EVENT_AFTER_SAVE_NOTIFICATION, function(NotificationEvent $event) {
$notification = $event->notification;
$isNew = $event->isNew;
// ...
});
beforeDeleteNotification event #The event that is triggered before an email notification is deleted.
use verbb\formie\events\NotificationEvent;
use verbb\formie\services\Notifications;
use yii\base\Event;
Event::on(Notifications::class, Notifications::EVENT_BEFORE_DELETE_NOTIFICATION, function(NotificationEvent $event) {
$notification = $event->notification;
// ...
});
afterDeleteNotification event #The event that is triggered after an email notification is deleted.
use verbb\formie\events\NotificationEvent;
use verbb\formie\services\Notifications;
use yii\base\Event;
Event::on(Notifications::class, Notifications::EVENT_AFTER_DELETE_NOTIFICATION, function(NotificationEvent $event) {
$notification = $event->notification;
// ...
});
modifyExistingNotifications event #The event that is triggered to allow modifying of available existing notifications to select from.
use verbb\formie\events\ModifyExistingNotificationsEvent;
use verbb\formie\services\Notifications;
use yii\base\Event;
Event::on(Notifications::class, Notifications::EVENT_MODIFY_EXISTING_NOTIFICATIONS, function(ModifyExistingNotificationsEvent $event) {
$notifications = $event->notifications;
// ...
});
beforeSendEmail event #The event that is triggered before an email is sent.
use verbb\formie\events\MailEvent;
use verbb\formie\services\Emails;
use yii\base\Event;
Event::on(Emails::class, Emails::EVENT_BEFORE_SEND_MAIL, function(MailEvent $event) {
$email = $event->email;
$submission = $event->submission;
$notification = $event->notification;
// ...
});
afterSendEmail event #The event that is triggered after an email is sent.
use verbb\formie\events\MailEvent;
use verbb\formie\services\Emails;
use yii\base\Event;
Event::on(Emails::class, Emails::EVENT_AFTER_SEND_MAIL, function(MailEvent $event) {
$email = $event->email;
$submission = $event->submission;
$notification = $event->notification;
// ...
});
beforeSaveEmailTemplate event #The event that is triggered before an email template is saved.
use verbb\formie\events\EmailTemplateEvent;
use verbb\formie\services\EmailTemplates;
use yii\base\Event;
Event::on(EmailTemplates::class, EmailTemplates::EVENT_BEFORE_SAVE_EMAIL_TEMPLATE, function(EmailTemplateEvent $event) {
$template = $event->template;
$isNew = $event->isNew;
// ...
});
afterSaveEmailTemplate event #The event that is triggered after an email template is saved.
use verbb\formie\events\EmailTemplateEvent;
use verbb\formie\services\EmailTemplates;
use yii\base\Event;
Event::on(EmailTemplates::class, EmailTemplates::EVENT_AFTER_SAVE_EMAIL_TEMPLATE, function(EmailTemplateEvent $event) {
$template = $event->template;
$isNew = $event->isNew;
// ...
});
beforeDeleteEmailTemplate event #The event that is triggered before an email template is deleted.
use verbb\formie\events\EmailTemplateEvent;
use verbb\formie\services\EmailTemplates;
use yii\base\Event;
Event::on(EmailTemplates::class, EmailTemplates::EVENT_BEFORE_DELETE_EMAIL_TEMPLATE, function(EmailTemplateEvent $event) {
$template = $event->template;
// ...
});
beforeApplyEmailTemplateDelete event #The event that is triggered before an email template is deleted.
use verbb\formie\events\EmailTemplateEvent;
use verbb\formie\services\EmailTemplates;
use yii\base\Event;
Event::on(EmailTemplates::class, EmailTemplates::EVENT_BEFORE_APPLY_EMAIL_TEMPLATE_DELETE, function(EmailTemplateEvent $event) {
$template = $event->template;
// ...
});
afterDeleteEmailTemplate event #The event that is triggered after an email template is deleted.
use verbb\formie\events\EmailTemplateEvent;
use verbb\formie\services\EmailTemplates;
use yii\base\Event;
Event::on(EmailTemplates::class, EmailTemplates::EVENT_AFTER_DELETE_EMAIL_TEMPLATE, function(EmailTemplateEvent $event) {
$template = $event->template;
// ...
});
beforeSaveFormTemplate event #The event that is triggered before an email template is saved.
use verbb\formie\events\FormTemplateEvent;
use verbb\formie\services\FormTemplates;
use yii\base\Event;
Event::on(FormTemplates::class, FormTemplates::EVENT_BEFORE_SAVE_FORM_TEMPLATE, function(FormTemplateEvent $event) {
$template = $event->template;
$isNew = $event->isNew;
// ...
});
afterSaveFormTemplate event #The event that is triggered after an email template is saved.
use verbb\formie\events\FormTemplateEvent;
use verbb\formie\services\FormTemplates;
use yii\base\Event;
Event::on(FormTemplates::class, FormTemplates::EVENT_AFTER_SAVE_FORM_TEMPLATE, function(FormTemplateEvent $event) {
$template = $event->template;
$isNew = $event->isNew;
// ...
});
beforeDeleteFormTemplate event #The event that is triggered before an email template is deleted.
use verbb\formie\events\FormTemplateEvent;
use verbb\formie\services\FormTemplates;
use yii\base\Event;
Event::on(FormTemplates::class, FormTemplates::EVENT_BEFORE_DELETE_FORM_TEMPLATE, function(FormTemplateEvent $event) {
$template = $event->template;
// ...
});
beforeApplyFormTemplateDelete event #The event that is triggered before an email template is deleted.
use verbb\formie\events\FormTemplateEvent;
use verbb\formie\services\FormTemplates;
use yii\base\Event;
Event::on(FormTemplates::class, FormTemplates::EVENT_BEFORE_APPLY_FORM_TEMPLATE_DELETE, function(FormTemplateEvent $event) {
$template = $event->template;
// ...
});
afterDeleteFormTemplate event #The event that is triggered after an email template is deleted.
use verbb\formie\events\FormTemplateEvent;
use verbb\formie\services\FormTemplates;
use yii\base\Event;
Event::on(FormTemplates::class, FormTemplates::EVENT_AFTER_DELETE_FORM_TEMPLATE, function(FormTemplateEvent $event) {
$template = $event->template;
// ...
});
registerFormieIntegrations event #The event that is triggered for registering new captcha integrations.
use verbb\formie\events\RegisterIntegrationsEvent;
use verbb\formie\services\Integrations;
use yii\base\Event;
Event::on(Integrations::class, Integrations::EVENT_REGISTER_INTEGRATIONS, function(RegisterIntegrationsEvent $event) {
$event->captchas = new myCaptcha();
// ...
});
beforeSaveIntegration event #The event that is triggered before an integration is saved.
use verbb\formie\events\IntegrationEvent;
use verbb\formie\services\Integrations;
use yii\base\Event;
Event::on(Integrations::class, Integrations::EVENT_BEFORE_SAVE_INTEGRATION, function(IntegrationEvent $event) {
$integration = $event->integration;
$isNew = $event->isNew;
// ...
});
afterSaveIntegration event #The event that is triggered after an integration is saved.
use verbb\formie\events\IntegrationEvent;
use verbb\formie\services\Integrations;
use yii\base\Event;
Event::on(Integrations::class, Integrations::EVENT_AFTER_SAVE_INTEGRATION, function(IntegrationEvent $event) {
$integration = $event->integration;
$isNew = $event->isNew;
// ...
});
beforeDeleteIntegration event #The event that is triggered before an integration is deleted
use verbb\formie\events\IntegrationEvent;
use verbb\formie\services\Integrations;
use yii\base\Event;
Event::on(Integrations::class, Integrations::EVENT_BEFORE_DELETE_INTEGRATION, function(IntegrationEvent $event) {
$integration = $event->integration;
// ...
});
beforeApplyIntegrationDelete event #The event that is triggered before a integration delete is applied to the database.
use verbb\formie\events\IntegrationEvent;
use verbb\formie\services\Integrations;
use yii\base\Event;
Event::on(Integrations::class, Integrations::EVENT_BEFORE_APPLY_INTEGRATION_DELETE, function(IntegrationEvent $event) {
$integration = $event->integration;
// ...
});
afterDeleteIntegration event #The event that is triggered after an integration is deleted
use verbb\formie\events\IntegrationEvent;
use verbb\formie\services\Integrations;
use yii\base\Event;
Event::on(Integrations::class, Integrations::EVENT_AFTER_DELETE_INTEGRATION, function(IntegrationEvent $event) {
$integration = $event->integration;
// ...
});
The below events an example using the Mailchimp class, but any class that inherits from the verbb\formie\base\Integration class can use these events.
beforeSendPayload event #The event that is triggered before an integration sends its payload.
The isValid event property can be set to false to prevent the payload from being sent.
use verbb\formie\events\SendIntegrationPayloadEvent;
use verbb\formie\integrations\emailmarketing\Mailchimp;
use yii\base\Event;
Event::on(Mailchimp::class, Mailchimp::EVENT_BEFORE_SEND_PAYLOAD, function(SendIntegrationPayloadEvent $event) {
$submission = $event->submission;
$payload = $event->payload;
$integration = $event->integration;
$endpoint = $event->endpoint;
$method = $event->method;
// ...
});
afterSendPayload event #The event that is triggered after an integration sends its payload.
The isValid event property can be set to false to flag a payload-sending response.
use verbb\formie\events\SendIntegrationPayloadEvent;
use verbb\formie\integrations\emailmarketing\Mailchimp;
use yii\base\Event;
Event::on(Mailchimp::class, Mailchimp::EVENT_AFTER_SEND_PAYLOAD, function(SendIntegrationPayloadEvent $event) {
$submission = $event->submission;
$payload = $event->payload;
$integration = $event->integration;
$response = $event->response;
// ...
});
The below events an example using the Mailchimp class, but any class that inherits from the verbb\formie\base\Integration class can use these events.
beforeCheckConnection event #The event that is triggered before an integration has checked its connection.
The isValid event property can be set to false to prevent the payload from being sent.
use verbb\formie\events\IntegrationConnectionEvent;
use verbb\formie\integrations\emailmarketing\Mailchimp;
use yii\base\Event;
Event::on(Mailchimp::class, Mailchimp::EVENT_BEFORE_CHECK_CONNECTION, function(IntegrationConnectionEvent $event) {
$integration = $event->integration;
// ...
});
afterCheckConnection event #The event that is triggered after an integration has checked its connection.
use verbb\formie\events\IntegrationConnectionEvent;
use verbb\formie\integrations\emailmarketing\Mailchimp;
use yii\base\Event;
Event::on(Mailchimp::class, Mailchimp::EVENT_AFTER_CHECK_CONNECTION, function(IntegrationConnectionEvent $event) {
$integration = $event->integration;
$success = $event->success;
// ...
});
The below events an example using the Mailchimp class, but any class that inherits from the verbb\formie\base\Integration class can use these events.
beforeFetchFormSettings event #The event that is triggered before an integration fetches its available settings for the form settings.
The isValid event property can be set to false to prevent the payload from being sent.
use verbb\formie\events\IntegrationFormSettingsEvent;
use verbb\formie\integrations\emailmarketing\Mailchimp;
use yii\base\Event;
Event::on(Mailchimp::class, Mailchimp::EVENT_BEFORE_FETCH_FORM_SETTINGS, function(IntegrationFormSettingsEvent $event) {
$integration = $event->integration;
// ...
});
afterFetchFormSettings event #The event that is triggered after an integration fetches its available settings for the form settings.
use verbb\formie\events\IntegrationFormSettingsEvent;
use verbb\formie\integrations\emailmarketing\Mailchimp;
use yii\base\Event;
Event::on(Mailchimp::class, Mailchimp::EVENT_AFTER_FETCH_FORM_SETTINGS, function(IntegrationFormSettingsEvent $event) {
$integration = $event->integration;
$settings = $event->settings;
// ...
});
parseMappedFieldValue event #The event that is triggered when parsing the field value made during submission to the field mapped in the provider. Using this event allows you to modify how Formie translates content from Craft into the third-party provider.
You must use handled = true to flag you are overriding field content behaviour. If not, it'll fall back to Formie's default handling.
use verbb\formie\events\ParseMappedFieldValueEvent;
use verbb\formie\integrations\emailmarketing\Mailchimp;
use yii\base\Event;
Event::on(Mailchimp::class, Mailchimp::EVENT_PARSE_MAPPED_FIELD_VALUE, function(ParseMappedFieldValueEvent $event) {
$integrationField = $event->integrationField;
$formField = $event->formField;
$value = $event->value;
$submission = $event->submission;
$integration = $event->integration;
if ($formField->handle === 'myFieldHandle') {
$event->value = 'An overridden value';
// This tells Formie you've overridden the parsed value, and to use that.
$event->handled = true;
}
});
afterOauthCallback event #use verbb\formie\controllers\IntegrationsController;
use verbb\formie\events\OauthTokenEvent;
use yii\base\Event;
Event::on(IntegrationsController::class, IntegrationsController::EVENT_AFTER_OAUTH_CALLBACK, function(OauthTokenEvent $event) {
$token = $event->token;
// ...
});
beforeSaveToken event #The event that is triggered before an integration token is saved.
use verbb\formie\events\TokenEvent;
use verbb\formie\services\Tokens;
use yii\base\Event;
Event::on(Tokens::class, Tokens::EVENT_BEFORE_SAVE_TOKEN, function(TokenEvent $event) {
$token = $event->token;
$isNew = $event->isNew;
// ...
});
afterSaveToken event #The event that is triggered after an integration token is saved.
use verbb\formie\events\TokenEvent;
use verbb\formie\services\Tokens;
use yii\base\Event;
Event::on(Tokens::class, Tokens::EVENT_AFTER_SAVE_TOKEN, function(TokenEvent $event) {
$token = $event->token;
$isNew = $event->isNew;
// ...
});
beforeDeleteToken event #The event that is triggered before an integration token is deleted.
use verbb\formie\events\TokenEvent;
use verbb\formie\services\Tokens;
use yii\base\Event;
Event::on(Tokens::class, Tokens::EVENT_BEFORE_DELETE_TOKEN, function(TokenEvent $event) {
$token = $event->token;
// ...
});
afterDeleteToken event #The event that is triggered after an integration token is deleted.
use verbb\formie\events\TokenEvent;
use verbb\formie\services\Tokens;
use yii\base\Event;
Event::on(Tokens::class, Tokens::EVENT_AFTER_DELETE_TOKEN, function(TokenEvent $event) {
$token = $event->token;
// ...
});
modifyAddressProviderHtml event #The event that is triggered after an address provider has its HTML generated. You are able to modify its HTML.
use verbb\formie\events\ModifyAddressProviderHtmlEvent;
use verbb\formie\integrations\addressproviders\AddressFinder;
use yii\base\Event;
Event::on(AddressFinder::class, AddressFinder::EVENT_MODIFY_ADDRESS_PROVIDER_HTML, function(ModifyAddressProviderHtmlEvent $event) {
$html = $event->html;
// ...
});
modifyWebhookPayload event #The event that is triggered to allow modification of the payload sent to your defined webhook URL.
use verbb\formie\events\ModifyWebhookPayloadEvent;
use verbb\formie\integrations\webhooks\Zapier;
use yii\base\Event;
Event::on(Zapier::class, Zapier::EVENT_MODIFY_WEBHOOK_PAYLOAD, function(ModifyWebhookPayloadEvent $event) {
$payload = $event->payload;
// ...
});
beforeSaveStencil event #The event that is triggered before a stencil is saved.
use verbb\formie\events\StencilEvent;
use verbb\formie\services\Stencils;
use yii\base\Event;
Event::on(Stencils::class, Stencils::EVENT_BEFORE_SAVE_STENCIL, function(StencilEvent $event) {
$stencil = $event->stencil;
$isNew = $event->isNew;
// ...
});
afterSaveStencil event #The event that is triggered after a stencil is saved.
use verbb\formie\events\StencilEvent;
use verbb\formie\services\Stencils;
use yii\base\Event;
Event::on(Stencils::class, Stencils::EVENT_AFTER_SAVE_STENCIL, function(StencilEvent $event) {
$stencil = $event->stencil;
$isNew = $event->isNew;
// ...
});
beforeDeleteStencil event #The event that is triggered before a stencil is deleted.
use verbb\formie\events\StencilEvent;
use verbb\formie\services\Stencils;
use yii\base\Event;
Event::on(Stencils::class, Stencils::EVENT_BEFORE_DELETE_STENCIL, function(StencilEvent $event) {
$stencil = $event->stencil;
// ...
});
beforeApplyStencilDelete event #The event that is triggered before a stencil is deleted.
use verbb\formie\events\StencilEvent;
use verbb\formie\services\Stencils;
use yii\base\Event;
Event::on(Stencils::class, Stencils::EVENT_BEFORE_APPLY_STENCIL_DELETE, function(StencilEvent $event) {
$stencil = $event->stencil;
// ...
});
afterDeleteStencil event #The event that is triggered after a stencil is deleted.
use verbb\formie\events\StencilEvent;
use verbb\formie\services\Stencils;
use yii\base\Event;
Event::on(Stencils::class, Stencils::EVENT_AFTER_DELETE_STENCIL, function(StencilEvent $event) {
$stencil = $event->stencil;
// ...
});
modifyField event #The event that is triggered during a migration (from Sprout Forms or Freeform), trying to map the respective third-party field to a Formie field. The field variable represents the Sprout Forms or Freeform field, and newField represents the Formie equivalent field.
You can use this event to custom Sprout Forms or Freeform field to a field Formie can understand.
use verbb\formie\events\ModifyMigrationFieldEvent;
use verbb\formie\migrations\MigrateFreeform;
use yii\base\Event;
Event::on(MigrateFreeform::class, MigrateFreeform::EVENT_MODIFY_FIELD, function(ModifyMigrationFieldEvent $event) {
$field = $event->field;
$newField = $event->newField;
// ...
});
use verbb\formie\events\ModifyMigrationFieldEvent;
use verbb\formie\migrations\MigrateSproutForms;
use yii\base\Event;
Event::on(MigrateSproutForms::class, MigrateSproutForms::EVENT_MODIFY_FIELD, function(ModifyMigrationFieldEvent $event) {
$field = $event->field;
$newField = $event->newField;
// ...
});
← Miscellaneous Hooks →
Available for Craft 3. Get it from the plugin store.