PluginProbe
Mailchimp List Subscribe Form / 1.5
Mailchimp List Subscribe Form v1.5
1.2.4 1.2.5 1.2.6 1.2.7 1.2.8 1.2.9 1.3 1.4 1.4.1 1.4.2 1.4.3 1.4.4 1.4.5 1.5 1.5.1 1.5.2 1.5.3 1.5.4 1.5.5 1.5.6 1.5.7 1.5.8 1.5.9 1.6.0 1.6.1 All 55 releases
mailchimp / README.md

README.md in Mailchimp List Subscribe Form 1.5, at README.md

226 lines 10.2 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === MailChimp List Subscribe Form ===
2 Contributors: crowdfavorite
3 Tags: mailchimp, email, newsletter, signup, marketing, plugin, widget
4 Requires at least: 2.8
5 Tested up to: 4.5
6 Stable tag: 1.5
7
8 == Description ==
9
10 Use the MailChimp List Subscribe plugin to quickly add a MailChimp signup form widget to your WordPress 2.8 or higher site.
11
12 After installation, you’ll log in with your API key, select your MailChimp list, choose merge fields and groups, and add the widget to your site. Typically, installation and setup will take about 5-10 minutes, and absolutely everything can be done via the WordPress Setting GUI, with no file editing at all.
13
14 == Installation ==
15
16 This section describes how to install the plugin and get started using it.
17
18 = Version 2.8+ =
19 1. Unzip our archive and upload the entire mailchimp directory to your `/wp-content/plugins/ directory`
20 2. Activate the plugin through the **Plugins** menu in WordPress
21 3. Navigate to **Settings** click **MailChimp Setup**.
22 4. Enter your MailChimp API Key and let the plugin verify it.
23 5. Select the list where you want to send new MailChimp subscribers.
24 6. Optional: turn **MonkeyRewards** on or off.
25 7. Optional: Turn **Merge Fields** and **Groups** on or off. Navigate to **Appearance**, and click **Widgets**. Drag the MailChimp Widget into one of your Widget Areas.
26
27
28 = Advanced =
29 If you have a custom coded sidebar or bells and whistles that prevent enabling widgets through the WordPress GUI, complete these steps instead.
30
31 WordPress v2.8 or higher:
32 ` [mailchimpsf_form] `
33
34 If you are adding it inside a php code block, pop this in:
35
36 ` mailchimpSF_signup_form(); `
37
38 Or, if you are dropping it in between a bunch of HTML, use this:
39
40 `<?php mailchimpSF_signup_form(); ?>`
41
42 Where ever you want it to show up.
43
44 Note: in some environments you will need to install the Exec_PHP plugin to use that method of display. It can be found here: http://wordpress.org/extend/plugins/exec-php/
45
46 == Upgrading ==
47
48 If you are upgrading to version 1.2.1 and you used the widget in your sidebar previously, all you need to do is drag the `MailChimp Widget` back into the sidebar, visit the MailChimp settings page (which will have maintained your prior settings), click the "Update List" button, and you're done!
49
50 == Internationalization (i18n) ==
51 Currently we have the plugin configured so it can be easily translated and the following languages supported:
52
53 * bg_BG - Bulgarian in Bulgaria (thanks to [](http://www.siteground.com/wordpress-hosting.htmSiteGround](http://www.siteground.com/wordpress-hosting.htm](http://www.siteground.com/wordpress-hosting.htm) for contributing)
54 * cs_CZ - Czech in the Czech Republic (thanks to [](http://kahi.cz/Peter Kahoun](http://kahi.cz/](http://kahi.cz/) for contributing)
55 * da_DK - Danish in Denmark (thanks to Jan Lund for contributing)
56 * de_DE - German in Germany (thanks to Michael Jaekel for contributing)
57 * el_GR - Modern Greek in Greece (thanks to Ιωάννης Δημοφέρλιας (John Dimoferlias) for contributing)
58 * en_US - English in the U.S.
59 * es_CL - Spanish in Chile (thanks to Tomás Nader for contributing)
60 * es_ES - Spanish in Spain (thanks to [](http://cricava.com/Claudia Mansilla](http://cricava.com/](http://cricava.com/) for contributing)
61 * et_ET - Estonian in Estonia (thanks to [](http://www.motomaania.ee/Helen Urbanik](http://www.motomaania.ee/](http://www.motomaania.ee/) for contributing)
62 * fr_FR - French in France (thanks to [](http://www.maximetoulliou.com/Maxime Toulliou](http://www.maximetoulliou.com/](http://www.maximetoulliou.com/) for contributing)
63 * he_IL - Hebrew in Israel (thanks to [](http://www.sagive.co.ilשגיב בית](http://www.sagive.co.il](http://www.sagive.co.il) for contributing)
64 * hu_HU - Hungarian in Hungary (thanks to Okostobi for contributing)
65 * it_IT - Italian in Italy (thanks to [](http://www.stefandes.comStefan Des](http://www.stefandes.com](http://www.stefandes.com) for contributing)
66 * ko_KR - Korean (thanks to 백선기 (SK Baek) for contributing)
67 * nb_NO - Norwegian (thanks to [](http://www.tigerpews.comAlexander Roterud aka Defrag](http://www.tigerpews.com](http://www.tigerpews.com) for contributing)
68 * nl_BE - Dutch (thanks to [](http://suddenelfilio.net/Filip Stas](http://suddenelfilio.net/](http://suddenelfilio.net/) for contributing)
69 * pt_BR - Portuguese in Brazil (thanks to Maria Manoela Porto for contributing)
70 * pt_PT - Portuguese in Portugal (thanks to [](http://xroot.orgTiago Faria](http://xroot.org](http://xroot.org) for contributing)
71 * ro_RO - Romanian in Romania (thanks to Alexandru Armin Roșu for contributing)
72 * ru_RU - Russian in the Russian Federation (thanks to [](http://fatcow.comИлья](http://fatcow.com](http://fatcow.com) for contributing)
73 * sv_SE - Swedish in Sweden (thanks to [](http://www.agiley.se/Sebastian Johnsson](http://www.agiley.se/](http://www.agiley.se/) for contributing)
74 * tr_TR - Turkish in Turkey (thanks to [](http://kazancexpert.com/Hakan E.](http://kazancexpert.com/](http://kazancexpert.com/) for contributing)
75
76 If your language is not listed above, feel free to create a translation. Here are the basic steps:
77
78 1. Copy "mailchimp_i18n-en_US.po" to "mailchimp_i18n-LANG_COUNTRY.po" - fill in LANG and COUNTRY with whatever you use for WPLANG in wp-config.php
79 2. Grab a transalation editor. [](http://www.poedit.net/POedit](http://www.poedit.net/](http://www.poedit.net/) works for us
80 3. Translate each line - if you need some context, just open up mailchimp.php and search for the line number or text
81 4. [](http://help.github.com/fork-a-repo/Fork](http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) the [](https://github.com/crowdfavorite/wp-mailchimprepository on github](https://github.com/crowdfavorite/wp-mailchimp](https://github.com/crowdfavorite/wp-mailchimp)
82 5. [](http://help.github.com/remotes/#cloneClone](http://help.github.com/remotes/#clone](http://help.github.com/remotes/#clone) the _develop_ branch
83 6. Add the appropriately named files to the /po/ directory and edit the /readme.txt to include how you'd like to be attributed
84 7. Make a [](http://help.github.com/send-pull-requests/pull request](http://help.github.com/send-pull-requests/](http://help.github.com/send-pull-requests/)
85
86
87 == Frequently Asked Questions ==
88
89 = What in the world is MailChimp? =
90
91 Good question! [](http://mailchimp.com/features/all/MailChimp](http://mailchimp.com/features/all/](http://mailchimp.com/features/all/) is full of useful, powerful email marketing features that are easy to use and even a little fun (that's right---we said fun), whether you're an email marketing expert, or a small business just getting started.
92
93 To learn more, just check out our site: [](http://mailchimp.com/features/all/MailChimp](http://mailchimp.com/features/all/](http://mailchimp.com/features/all/)
94
95
96 = Wait a minute, you want me to pay to try this? =
97
98 *Absolutely not!* We welcome you to come signup for a [](http://mailchimp.com/signup/FREE Trial Account](http://mailchimp.com/signup/](http://mailchimp.com/signup/) and see if you find it useful.
99
100 = I want this in my language, do you have a translation? =
101 Maybe! Look in the /po/ directory in our plugin package and see if your language is in there. If it is, great! If it is not, feel from to create one. Here are the basic steps:
102
103 1. Copy "mailchimp_i18n-en_US.po" to "mailchimp_i18n-LANG_COUNTRY.po" - fill in LANG and COUNTRY with whatever you use for WPLANG in wp-config.php
104 2. Grab a transalation editor. [](http://www.poedit.net/POedit](http://www.poedit.net/](http://www.poedit.net/) works for us
105 3. Translate each line - if you need some context, just open up mailchimp.php and search for the line number or text
106 4. [](http://help.github.com/fork-a-repo/Fork](http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) the [](https://github.com/crowdfavorite/wp-mailchimprepository on github](https://github.com/crowdfavorite/wp-mailchimp](https://github.com/crowdfavorite/wp-mailchimp)
107 5. [](http://help.github.com/remotes/#cloneClone](http://help.github.com/remotes/#clone](http://help.github.com/remotes/#clone) the _develop_ branch
108 6. Add the appropriately named files to the /po/ directory and edit the /readme.txt to include how you'd like to be attributed
109 7. Make a [](http://help.github.com/send-pull-requests/pull request](http://help.github.com/send-pull-requests/](http://help.github.com/send-pull-requests/)
110
111
112 == Screenshots ==
113
114 1. Entering your MailChimp login info
115 2. Selecting your MailChimp list
116 3. Configuring your Signup Form display format (optional)
117 4. Configuring extra fields on your Signup Form (optional)
118 5. An example Signup Form Widget
119
120 == Upgrade Notice ==
121
122 = 1.5 =
123 Updates the MailChimp API version, adds double/single opt-in toggle.
124
125 = 1.4.2 =
126 add customized wp_nonces functions for post-back behavior to fix 4.0 callbacks
127
128 = 1.4.1 =
129 Fix for checkbox weirdness on 3.8
130
131 = 1.4 =
132 Added Developer Mode "Kitchen Sink" to aid in styling without having to authenticate a MailChimp account.
133
134 = 1.3 =
135 Now using OAuth flow within plugin for user authentication
136
137 Admin UI refresh
138
139 = 1.2.11 =
140 Merged pull request from https://github.com/headshift/wp-mailchimp adding additional translation strings.
141
142 = 1.2.10 =
143 Fixed submission error when apostrophes are present
144
145 = 1.2.8=
146 Fixes bug where entire phone numbers were only being deposited in the area code portion
147
148 = 1.2.6 =
149 Fixes major bug with "Settings" link on Plugins screen.
150
151 = 1.2.5 =
152 Added support for multiple interest groups, field formatting based on type and date picker.
153
154 == Changelog ==
155
156 = 1.5 =
157 * Upgrade to MailChimp API v3.0
158 * Remove OAuth2 middle layer and use MailChimp API keys
159 * Include double/single opt-in toggle.
160
161 = 1.4.1 =
162 * Update styles to be compatible with upcoming 3.8 wp-admin changes
163
164 = 1.4 =
165 * Developer Mode "Kitchen Sink" takes over plugin for local development
166 * Developer Mode has filters of changable content
167 * Fix bug related to required US phone validation
168
169 = 1.3 =
170 * Now using OAuth flow for user authentication
171 * Admin UI refresh
172
173 = 1.2.14 =
174 * Add link to edit profile within error when duplicate signup occurs
175
176 = 1.2.13 =
177 * Fixed bug preventing address fields from submitting correctly.
178
179 = 1.2.12 =
180 * Update spanish language files (es_ES and es_MX)
181
182 = 1.2.9 =
183 * Fixed bug where multiple checkbox type interest groups were returning an invalid error
184 * Fixed bug where assets were not enqueueing properly if the plugin directory was not set to 'mailchimp'. Now supports any directory name.
185
186 = 1.2.8 =
187 * Fixed bug where entire phone numbers were only being deposited in the area code portion
188
189 = 1.2.7 =
190 * CSS should now always load correctly on the front end
191 * Adding Hebrew and Romanian language support
192 * Updating translation contribution instructions
193 * Tested version is now 3.3.1
194
195 = 1.2.6 =
196 * Fixed bug with "Settings" link appearing on all plugins (props Jason Lane)
197 * Resolved issue with unnecessary calls to the MailChimp API during upgrade check
198 * Resolved PHP warning when there weren't any interest groups
199
200 = 1.2.5 =
201 * Field formatting based on type
202 * Support for multiple interest groups (a data upgrade procedure must be run by visiting the WordPress dashboard)
203 * Added jQuery datepicker option to be used with dates.
204 * Added a handful of new translations
205 * Fixing various PHP notices and deprecated functions (props Jeffry Ghazally)
206
207 = 1.2.4 =
208 * Version bump for proper listing on wordpress.org
209
210 = 1.2.3 =
211 * Change mailchimpSF_where_am_i() to use plugins_url() in place of WP_PLUGIN_URL to take SSL into account when delivering assets (props John LeBlanc)
212 * Update MCAPI wrapper to bring back PHP4 support (note: PHP 5.2 to be required starting with WordPress 3.2)
213
214 = 1.2.2 =
215 * Change MCAPI wrapper to use a more unique class name, v1.3 of the API, and a much lighter client library
216
217 = 1.2.1 =
218 * Fixed internationalization path bug.
219 * Fixed instances where i18n functions weren't necessary in admin.
220 * Added more strings to be translated.
221
222 = 1.2 =
223 * Recommended Upgrade, please see "Upgrading" section of readme.
224 * Security and various other improvements
225
226