zirak / silverstripe-mailchimp
Adds mailchimp integration to SilverStripe, eventually inside a widget
Installs: 87
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 5
Open Issues: 1
Type:silverstripe-module
Requires
- silverstripe/cms: 3.1.*
- silverstripe/framework: 3.1.*
Suggests
- silverstripe/widgets: Allows having mailchimp subscription inside widgets
- zirak/widget-pages-extension: Allows having mailchimp subscription form in a single widget shared through pages
This package is not auto-updated.
Last update: 2024-09-28 16:25:50 UTC
README
MailChimp subscription form
The form could be injected into a widget, or used inside a page through the MailChimp extension
Maintainer Contact
Gabriele Brosulo [gabriele.brosulo (at) zirak (dot) it]
Features
- Subscription widget form
- Static function callable from outside
Requirements
- Silverstripe framework 3.1.*
- Silverstripe cms 3.1.*
Suggestions
- silverstripe/widget
- zirak/widget-pages-extension
Install
Install it through composer:
composer require zirak/silverstripe-mailchimp
Using in a page
Extend the Page class (or whatever class you want to use) whit the MailChimp extension:
--- Name: mailchimp-extensions --- Page: extensions: - MailChimp
Then render the $McSubscribeForm variable inside your template:
<% include SideBar %>
<div class="content-container unit size3of4 lastUnit">
<article>
<h1>$Title</h1>
<div class="content">$Content</div>
</article>
$Form
$PageComments
$McSubscribeForm
</div>
Using inside a widget
Simply use the MailChimpSubscribe widget as usual documentation here
Using inside a widget with widget-pages-extension
Define the widgetareas in your pages, like stated in widget-pages-extension module After that define which widget are allowed for your pages, in particular MailChimpSubscribe.
For example your Page.php will become
class Page extends SiteTree { private static $db = array( ); private static $has_one = array( 'SideBar' => 'WidgetArea' ); private static $allowed_widgets = array( 'MailChimpSubscribe' ); }
Run a /dev/build?flush=all and enjoy your widgets. Due to a known issue in widget-pages-extension you have to save each page you will need to put the widgets on. For more information about how to use the widgets please see the widget-pages-extension module documentations
Usage
- Configure your MailChimp APIKEY and ListID
- Enable the widget
- Play with the mailchimp.yml config file in your mysite folder, in conjunction with the MailChimp configurations. Follow a sample mailchimp.yml
--- Name: mailchimp --- MailChimpController: #apikey - see http://admin.mailchimp.com/account/api apikey: 'afe564e2dbbeb74f392de68f927ac326ef4-us6' # A List Id to run examples against. use lists() to view all # Also, login to MC account, go to List, then List Tools, and look for the List ID entry listid: '8e5f26f915' redirect: true redirect_ok: 'reg-ok/' redirect_ko: 'reg-ko/' country: true topics: true topicsArr: ['Web development', 'Sysadmin', 'PHP', 'Javascript', 'HTML & CSS'] otherTopic: true