swordfox/silverstripe-userform-mailchimpfield

Adds a custom field to UserForms which allows you to select a list from MailChimp and subscribe on submission.

2.2.1 2024-09-26 01:35 UTC

Requires

• composer/installers: *
• drewm/mailchimp-api: ^2.5
• silverstripe/cms: ^5
• silverstripe/framework: ^5
• silverstripe/userforms: ^6
• symbiote/silverstripe-gridfieldextensions: ^4

BSD-3-Clause

• Graham McLellan

• mailchimp
• silverstripe
• userforms

README

#MailChimp UserForm Field Adds a custom field to UserForms which allows you to select a list from MailChimp and subscribe on submission.

Also allows additional merge_fields to be added for each field in the form.

Installation

Via composer

composer require swordfox/silverstripe-userform-mailchimpfield

Configuration

To connect to your MailChimp field you will need to set two fields in your config.yml.

Swordfox\UserForms\EditableMailChimpField:
  api_key: 'API KEY GOES HERE'

^ These setting can be found in client settings area in MailChimp.

Customisation

You can also change what type of field is actually used on the UserForm. By Default it's a checkbox field. You can change this via your config.yml OR via the CMS per form.

Extensions

There are a few extension hooks which can be useful to handle data before and after saving throughout the process.

• $this->extend('beforeValueFromData', $data)
• $this->extend('afterValueFromData', $data)
• $this->extend('updateLists', $data)