Skip to content
Newer
Older
100644 258 lines (184 sloc) 12.4 KB
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
1 === MailChimp List Subscribe Form ===
7c25ec2 @jondavidjohn bump version for release, update readme
jondavidjohn authored
2 Contributors: crowdfavorite
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
3 Tags: mailchimp, email, newsletter, signup, marketing, plugin, widget
4 Requires at least: 2.8
3f48cbe Updated changelog.
Steven Mathias authored
5 Tested up to: 4.0
a84a75f @kidfiction Incrementing version
kidfiction authored
6 Stable tag: 1.4.3
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
7
8 == Description ==
9
10 The MailChimp plugin allows you to quickly and easily add a signup form for your MailChimp list as a widget on your WordPress 2.8 or higher site.
11
12 Not sure what [MailChimp](http://www.mailchimp.com/features/full_list/) is or if it will be helpful? Signup up for a [FREE Trial Account](http://www.mailchimp.com/signup/) and see for yourself!
13
14 After Installation, the setup page will guide you through entering your Login information, selecting your List from our Service, selecting options for the Merge Fields and Interest Groups you have setup, and then add the Widget to your site. The time from starting installation to have the form on your site should be less than 5 minutes - absolutely everything can be done via the Wordpress Setting GUI - no file editing at all!
15
16 == Installation ==
17
18 This section describes how to install the plugin and get started using it.
19
20 = Version 2.8+ =
21 1. Unzip our archive and upload the entire `mailchimp` directory to your `/wp-content/plugins/` directory
22 2. Activate the plugin through the 'Plugins' menu in WordPress
23 3. Go to Settings and look for "MailChimp Setup" in the menu
24 4. Enter your MailChimp API Key and let the plugin verify it.
25 5. Select One of your lists to have your visitors subscribe to.
26 6. (optionally) Turn on or off the Monkey Rewards option
27 7. (optionally) Turn your Merge Vars and Interest Groups `on` and `off`
28 8. Finally, go to Appearance->Widgets and drag the `MailChimp Widget` widget into one of your Widget Areas
29 9. And you are DONE!
30
31 = Advanced =
32 If you have a custom coded sidebar or something else special going on where you can't simply enable the widget through the Wordpress GUI, all you need to do is:
33
34 If you are using Wordpress v2.8 or higher, you can use the short-code:
35 ` [mailchimpsf_form] `
36
37 If you are adding it inside a php code block, pop this in:
38
39 ` mailchimpSF_signup_form(); `
40
41 Or, if you are dropping it in between a bunch of HTML, use this:
42
43 `<?php mailchimpSF_signup_form(); ?>`
44
ad06d7c @jondavidjohn bump version numbers
jondavidjohn authored
45 Where ever you want it to show up.
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
46
47 Note: in some environments you will need to install the Exec_PHP plugin to use that method of display. It can be found here:
48 http://wordpress.org/extend/plugins/exec-php/
49
d8f5016 @jondavidjohn update readme.txt
jondavidjohn authored
50 == Developer Mode ==
51
52 You can enable "Devleoper Mode" by adding the following line to your `wp-config.php` file just above the "That's all, stope editing!" line.
53
54 define('MAILCHIMP_DEV_MODE', true);
55
56 This will enable the MailChimp List Subscribe plugin to operate without the need to connect an external MailChimp Account, and will provide a
57 subscription form widget that will not actually submit anywhere.
58
59 This will allow you to style and configure the widget in non-production environments that are not publicly accessible.
60
61 For more Developer Mode customization options see the following article:
62
63 http://connect.mailchimp.com/how-to/how-to-article-configuring-developer-mode-for-the-list-subscribe-wordpress-plugin
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
64
65 == Upgrading ==
66
67 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!
68
69 == Internationalization (i18n) ==
70 Currently we have the plugin configured so it can be easily translated and the following languages supported:
71
5d891f0 Added notes for the Credits for ar_SA.po and bn_BD.po contributed by me
Lenin authored
72 * ar_SA - Arabic in Saudi Arabia and Middle East (thanks to [Lenin](http://twitter.com/nine_l) for compiling and Nagwa Ibrahim, Egypt for translating)
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
73 * bg_BG - Bulgarian in Bulgaria (thanks to [SiteGround](http://www.siteground.com/wordpress-hosting.htm) for contributing)
e99565f @MarcQueralt Catalan language files added
MarcQueralt authored
74 * ca - Catalan (thanks to [DeMomentSomTres Vilafranca Web Design](http://demomentsomtres.com) for contributing
5d891f0 Added notes for the Credits for ar_SA.po and bn_BD.po contributed by me
Lenin authored
75 * bn_BD - Bangla in Bangladesh (thanks to [Lenin](http://twitter.com/nine_l) for contributing)
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
76 * cs_CZ - Czech in the Czech Republic (thanks to [Peter Kahoun](http://kahi.cz/) for contributing)
77 * da_DK - Danish in Denmark (thanks to Jan Lund for contributing)
78 * de_DE - German in Germany (thanks to Michael Jaekel for contributing)
79 * el_GR - Modern Greek in Greece (thanks to Ιωάννης Δημοφέρλιας (John Dimoferlias) for contributing)
80 * en_US - English in the U.S.
81 * es_CL - Spanish in Chile (thanks to Tomás Nader for contributing)
82 * es_ES - Spanish in Spain (thanks to [Claudia Mansilla](http://cricava.com/) for contributing)
83 * et_ET - Estonian in Estonia (thanks to [Helen Urbanik](http://www.motomaania.ee/) for contributing)
84 * fr_FR - French in France (thanks to [Maxime Toulliou](http://www.maximetoulliou.com/) for contributing)
6d976c3 @jessedp err, this actually updates the readme with language attribution and m…
jessedp authored
85 * he_IL - Hebrew in Israel (thanks to [שגיב בית](http://www.sagive.co.il) for contributing)
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
86 * hu_HU - Hungarian in Hungary (thanks to Okostobi for contributing)
87 * it_IT - Italian in Italy (thanks to [Stefan Des](http://www.stefandes.com) for contributing)
88 * ko_KR - Korean (thanks to 백선기 (SK Baek) for contributing)
89 * nb_NO - Norwegian (thanks to [Alexander Roterud aka Defrag](http://www.tigerpews.com) for contributing)
90 * nl_BE - Dutch (thanks to [Filip Stas](http://suddenelfilio.net/) for contributing)
91 * pt_BR - Portuguese in Brazil (thanks to Maria Manoela Porto for contributing)
92 * pt_PT - Portuguese in Portugal (thanks to [Tiago Faria](http://xroot.org) for contributing)
6d976c3 @jessedp err, this actually updates the readme with language attribution and m…
jessedp authored
93 * ro_RO - Romanian in Romania (thanks to Alexandru Armin Roșu for contributing)
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
94 * ru_RU - Russian in the Russian Federation (thanks to [Илья](http://fatcow.com) for contributing)
95 * sv_SE - Swedish in Sweden (thanks to [Sebastian Johnsson](http://www.agiley.se/) for contributing)
96 * tr_TR - Turkish in Turkey (thanks to [Hakan E.](http://kazancexpert.com/) for contributing)
97
98 If your language is not listed above, feel free to create a translation. Here are the basic steps:
99
100 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
101 2. Grab a transalation editor. [POedit](http://www.poedit.net/) works for us
102 3. Translate each line - if you need some context, just open up mailchimp.php and search for the line number or text
6d976c3 @jessedp err, this actually updates the readme with language attribution and m…
jessedp authored
103 4. [Fork](http://help.github.com/fork-a-repo/) the [repository on github](https://github.com/crowdfavorite/wp-mailchimp)
4feaecf @jessedp add hebrew and romanian language files, update instrcuctions for fork…
jessedp authored
104 5. [Clone](http://help.github.com/remotes/#clone) the _develop_ branch
105 6. Add the appropriately named files to the /po/ directory and edit the /readme.txt to include how you'd like to be attributed
106 7. Make a [pull request](http://help.github.com/send-pull-requests/)
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
107
108
109 == Frequently Asked Questions ==
110
111 = What in the world is MailChimp? =
112
113 Good question! [MailChimp](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.
114
115 To learn more, just check out our site: [MailChimp](http://mailchimp.com/features/all/)
116
117
118 = Wait a minute, you want me to pay to try this? =
119
120 *Absolutely not!* We welcome you to come signup for a [FREE Trial Account](http://mailchimp.com/signup/) and see if you find it useful.
121
122 = I want this in my language, do you have a translation? =
123 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:
124
125 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
6d976c3 @jessedp err, this actually updates the readme with language attribution and m…
jessedp authored
126 2. Grab a transalation editor. [POedit](http://www.poedit.net/) works for us
127 3. Translate each line - if you need some context, just open up mailchimp.php and search for the line number or text
128 4. [Fork](http://help.github.com/fork-a-repo/) the [repository on github](https://github.com/crowdfavorite/wp-mailchimp)
4feaecf @jessedp add hebrew and romanian language files, update instrcuctions for fork…
jessedp authored
129 5. [Clone](http://help.github.com/remotes/#clone) the _develop_ branch
130 6. Add the appropriately named files to the /po/ directory and edit the /readme.txt to include how you'd like to be attributed
131 7. Make a [pull request](http://help.github.com/send-pull-requests/)
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
132
133
134 == Screenshots ==
135
136 1. Entering your MailChimp login info
137 2. Selecting your MailChimp list
138 3. Configuring your Signup Form display format (optional)
139 4. Configuring extra fields on your Signup Form (optional)
140 5. An example Signup Form Widget
141
142 == Upgrade Notice ==
143
64d08b2 @kidfiction Update changelog
kidfiction authored
144 = 1.4.3 =
145 Fixed an issue with improper URLs to updating profile settings
146 Fixed an issue in which backslashes, single and double quotes were having an extra slash attached
147 Fixed an issue in which logging out then attempting to reconnect with OAuth prevented actual login
148 Updated translation files to support the latest strings
149 Adjust how alerts are handled to prevent header from being seen
150 Update instances of home_url to properly refernce admin_url
151 Update to prevent PHP warnings when WP_DEBUG is enabled
152
3f48cbe Updated changelog.
Steven Mathias authored
153 = 1.4.2 =
154 add customized wp_nonces functions for post-back behavior to fix 4.0 callbacks
7c25ec2 @jondavidjohn bump version for release, update readme
jondavidjohn authored
155
3f48cbe Updated changelog.
Steven Mathias authored
156 = 1.4.1 =
157 Fix for checkbox weirdness on 3.8
7c25ec2 @jondavidjohn bump version for release, update readme
jondavidjohn authored
158
5ef5060 @mospaw Minor code tweaks. Change readme.txt to reflect new version.
mospaw authored
159 = 1.4 =
160 Added Developer Mode "Kitchen Sink" to aid in styling without having to authenticate a MailChimp account.
161
ad06d7c @jondavidjohn bump version numbers
jondavidjohn authored
162 = 1.3 =
163 Now using OAuth flow within plugin for user authentication
164
165 Admin UI refresh
166
4bbb8d8 Updated version number and readme
Steven Mathias authored
167 = 1.2.11 =
168 Merged pull request from https://github.com/headshift/wp-mailchimp adding additional translation strings.
169
187ad24 @jondavidjohn update readme
jondavidjohn authored
170 = 1.2.10 =
171 Fixed submission error when apostrophes are present
172
d2f5736 @kidfiction Updating version numbers, adding 1.2.8 to changelog
kidfiction authored
173 = 1.2.8=
174 Fixes bug where entire phone numbers were only being deposited in the area code portion
175
ad06d7c @jondavidjohn bump version numbers
jondavidjohn authored
176 = 1.2.6 =
144d657 @alexkingorg esc_url addition
alexkingorg authored
177 Fixes major bug with "Settings" link on Plugins screen.
675629a Upgrade notice added
Devin Reams authored
178
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
179 = 1.2.5 =
180 Added support for multiple interest groups, field formatting based on type and date picker.
181
182 == Changelog ==
1fead6f @jondavidjohn add release notes and bump version
jondavidjohn authored
183
9e043b8 @kidfiction Updates to the readme which includes 1.4.2 release
kidfiction authored
184 = 1.4.3 =
185 * Prevent assets from having double slashes in the URL which causes issues with caching plugins
186 * Prevent WP error bars from overlapping the header image and text
187 * Fixed an issue which generated the incorrect URL to update a profile
68da08f @kidfiction Define the hash_compare function if it doesnt already exist
kidfiction authored
188 * Fixed an issue which would occasionally prevent connection for users with versions of PHP < 5.6.0
9e043b8 @kidfiction Updates to the readme which includes 1.4.2 release
kidfiction authored
189
190 = 1.4.2 =
191 * Update to address changes in nonces for WP 4.0
192
7c25ec2 @jondavidjohn bump version for release, update readme
jondavidjohn authored
193 = 1.4.1 =
194 * Update styles to be compatible with upcoming 3.8 wp-admin changes
195
d8f5016 @jondavidjohn update readme.txt
jondavidjohn authored
196 = 1.4 =
5ef5060 @mospaw Minor code tweaks. Change readme.txt to reflect new version.
mospaw authored
197 * Developer Mode "Kitchen Sink" takes over plugin for local development
198 * Developer Mode has filters of changable content
d8f5016 @jondavidjohn update readme.txt
jondavidjohn authored
199 * Fix bug related to required US phone validation
5ef5060 @mospaw Minor code tweaks. Change readme.txt to reflect new version.
mospaw authored
200
ad06d7c @jondavidjohn bump version numbers
jondavidjohn authored
201 = 1.3 =
202 * Now using OAuth flow for user authentication
203 * Admin UI refresh
204
dc1f36b @jondavidjohn bump versions
jondavidjohn authored
205 = 1.2.14 =
206 * Add link to edit profile within error when duplicate signup occurs
207
a7e676c Updated to 1.2.13, fixing email address submission issues
Steven Mathias authored
208 = 1.2.13 =
209 * Fixed bug preventing address fields from submitting correctly.
210
1fead6f @jondavidjohn add release notes and bump version
jondavidjohn authored
211 = 1.2.12 =
212 * Update spanish language files (es_ES and es_MX)
213
76c689b @kidfiction Updating version numbers, includes 1.2.9 fixes (see change log)
kidfiction authored
214 = 1.2.9 =
215 * Fixed bug where multiple checkbox type interest groups were returning an invalid error
5b6ba6c @emerywebster Corrected readme typo
emerywebster authored
216 * Fixed bug where assets were not enqueueing properly if the plugin directory was not set to 'mailchimp'. Now supports any directory name.
76c689b @kidfiction Updating version numbers, includes 1.2.9 fixes (see change log)
kidfiction authored
217
ad06d7c @jondavidjohn bump version numbers
jondavidjohn authored
218 = 1.2.8 =
d2f5736 @kidfiction Updating version numbers, adding 1.2.8 to changelog
kidfiction authored
219 * Fixed bug where entire phone numbers were only being deposited in the area code portion
220
221 = 1.2.7 =
1f9cede @kidfiction Updating README changelog to reflect 1.2.7 and 1.2.8 changes
kidfiction authored
222 * CSS should now always load correctly on the front end
223 * Adding Hebrew and Romanian language support
224 * Updating translation contribution instructions
225 * Tested version is now 3.3.1
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
226
d3726ac @bigdawggi Bumping version number in plugin and readme file
bigdawggi authored
227 = 1.2.6 =
675629a Upgrade notice added
Devin Reams authored
228 * Fixed bug with "Settings" link appearing on all plugins (props Jason Lane)
4da041f @bigdawggi Noting issue resolution in readme notes
bigdawggi authored
229 * Resolved issue with unnecessary calls to the MailChimp API during upgrade check
7253ef1 @bigdawggi Adding note of PHP Warning fix to README
bigdawggi authored
230 * Resolved PHP warning when there weren't any interest groups
d3726ac @bigdawggi Bumping version number in plugin and readme file
bigdawggi authored
231
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
232 = 1.2.5 =
233 * Field formatting based on type
234 * Support for multiple interest groups (a data upgrade procedure must be run by visiting the WordPress dashboard)
235 * Added jQuery datepicker option to be used with dates.
236 * Added a handful of new translations
237 * Fixing various PHP notices and deprecated functions (props Jeffry Ghazally)
238
239 = 1.2.4 =
240 * Version bump for proper listing on wordpress.org
241
242 = 1.2.3 =
243 * 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)
244 * Update MCAPI wrapper to bring back PHP4 support (note: PHP 5.2 to be required starting with WordPress 3.2)
245
ad06d7c @jondavidjohn bump version numbers
jondavidjohn authored
246 = 1.2.2 =
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
247 * Change MCAPI wrapper to use a more unique class name, v1.3 of the API, and a much lighter client library
248
ad06d7c @jondavidjohn bump version numbers
jondavidjohn authored
249 = 1.2.1 =
6e33678 Initial commit (starting off at tag 1.2.5 on plugins.svn.wordpress.org)
Matt Richmond authored
250 * Fixed internationalization path bug.
251 * Fixed instances where i18n functions weren't necessary in admin.
252 * Added more strings to be translated.
253
254 = 1.2 =
255 * Recommended Upgrade, please see "Upgrading" section of readme.
256 * Security and various other improvements
257
Something went wrong with that request. Please try again.