forked from ibericode/mailchimp-top-bar
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
418 lines (239 loc) · 12 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
=== MailChimp Top Bar ===
Contributors: Ibericode, DvanKooten, hchouhan, lapzor
Donate link: https://mc4wp.com/#utm_source=wp-plugin-repo&utm_medium=mailchimp-top-bar&utm_campaign=donate-link
Tags: mailchimp, form, newsletter, mc4wp, email, opt-in, subscribe, call to action
Requires at least: 3.8
Tested up to: 4.6.1
Stable tag: 1.2.15
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Adds a MailChimp opt-in form in a top bar to your WordPress site.
== Description ==
Adds a beautiful, customizable sign-up bar to the top of your WordPress site. This bar is guaranteed to get the attention of your visitor and
increase your MailChimp subscribers.
> This plugin is an add-on for the [MailChimp for WordPress plugin](https://wordpress.org/plugins/mailchimp-for-wp/).
= MailChimp Sign-Up Bar, at a glance.. =
MailChimp Top Bar adds a simple yet beautiful & customizable opt-in bar to the top or bottom of your WordPress site.
Using this bar, people can subscribe to a MailChimp list of your choice.
- Guaranteed to boost conversions.
- Unobtrusive, visitors can easily dismiss the bar.
- Easy to install & configure, just select a MailChimp list and you're good to.
- Customizable, you can edit the bar text and colors from the plugin settings.
- The bar can be at the top or bottom of the visitor's screen
- Lightweight, the plugin consists of just a single 4kb JavaScript file.
= Development of MailChimp Top Bar =
Bug reports (and Pull Requests) for [MailChimp Top Bar are welcomed on GitHub](https://github.com/ibericode/mailchimp-top-bar). Please note that GitHub is _not_ a support forum.
**More information**
- [MailChimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/)
- Developers; follow or contribute to the [MailChimp Top Bar plugin on GitHub](https://github.com/ibericode/mailchimp-top-bar)
- Other [WordPress plugins](https://dannyvankooten.com/wordpress-plugins/#utm_source=wp-plugin-repo&utm_medium=link&utm_campaign=more-info-link) by [Danny van Kooten](https://dannyvankooten.com#utm_source=wp-plugin-repo&utm_medium=link&utm_campaign=more-info-link)
- [@DannyvanKooten](https://twitter.com/dannyvankooten) on Twitter
== Installation ==
= MailChimp for WordPress =
Since this plugin depends on the [MailChimp for WordPress plugin](https://wordpress.org/plugins/mailchimp-for-wp/), you will need to install that first.
= Installing MailChimp Top Bar =
1. In your WordPress admin panel, go to *Plugins > New Plugin*, search for **MailChimp Top Bar** and click "*Install now*"
1. Alternatively, download the plugin and upload the contents of `mailchimp-top-bar.zip` to your plugins directory, which usually is `/wp-content/plugins/`.
1. Activate the plugin
1. Set [your MailChimp API key](https://admin.mailchimp.com/account/api) in **MailChimp for WP > MailChimp Settings**.
1. Select a MailChimp list to subscribe to in **MailChimp for WP > Top Bar**.
1. _(Optional)_ Customize the look & position of your opt-in bar.
== Frequently Asked Questions ==
= How to disable the bar on certain pages? =
For now, you will have to use a filter to disable the bar on certain pages. The following example only loads the Top Bar on your blog post pages.
`
add_filter( 'mctb_show_bar', function( $show ) {
return is_single();
} );
`
Another example, this only loads the bar on your "contact" page.
`
add_filter( 'mctb_show_bar', function( $show ) {
return is_page('contact');
} );
`
Have a look at the [Conditional Tags](https://codex.wordpress.org/Conditional_Tags) page for all accepted functions.
= How to add a name field to the bar? =
You can use the following code snippet to show a "NAME" field in your bar.
`
add_action( 'mctb_before_submit_button', function() {
echo '<input type="text" name="NAME" placeholder="Your name" />';
});
add_filter( 'mctb_merge_vars', function( $vars ) {
$vars['NAME'] = ( isset( $_POST['NAME'] ) ) ? sanitize_text_field( $_POST['NAME'] ) : '';
return $vars;
});
`
**KB:** [Add name field to MailChimp Top Bar](https://mc4wp.com/kb/add-name-field-to-mailchimp-top-bar/)
= How to hide the bar on small screens? =
Adding the following CSS to your site should hide the bar on all screens smaller than 600px. The [Simple Custom CSS](https://wordpress.org/plugins/simple-custom-css/) plugin is great for adding custom CSS.
`
@media( max-width: 600px ) {
#mailchimp-top-bar { display: none !important; }
}
`
= I think I found a bug. What now? =
Please report it on [GitHub issues](https://github.com/ibericode/mailchimp-top-bar/issues) if it's not in the list of known issues.
= I have another question =
Please open a topic on the [WordPress.org plugin support forums](https://wordpress.org/support/plugin/mailchimp-top-bar).
== Screenshots ==
1. The MailChimp Top Bar in action on the [MailChimp for WordPress site](https://mc4wp.com/#utm_source=wp-plugin-repo&utm_medium=mailchimp-top-bar&utm_campaign=screenshots).
2. The settings page of the MailChimp Top Bar plugin.
== Changelog ==
#### 1.2.15 - September 8, 2016
**Improvements**
- Improved responsiveness when bar has additional input fields.
- Add `required` attribute to email input.
#### 1.2.14 - August 29, 2016
**Fixes**
- Top padding for small screens with admin bar.
**Improvements**
- Better bar responsiveness when window dimensions change on the fly (eg resizing a window or changing device orientation mode). (Thanks [tech4him1](https://github.com/tech4him1)!)
#### 1.2.13 - August 2, 2016
**Fixes**
- Error in animating body padding back to its original value.
#### 1.2.12 - July 21, 2016
**Fixes**
- Bar would crash when clicking toggle icon during bar animation.
**Improvements**
- Function scope generated JavaScript file to prevent Browserify clashes with other loaded scripts.
- Make sure script works even though it's loaded in the head section.
- Preparations for upcoming MailChimp for WordPress v4.0 release.
**Additions**
- Added Spanish language files, thanks to [Ángel Guzmán Maeso](http://shakaran.net/)
- Added `mctb_data` filter, to filter form data before it is processed.
**Deprecated**
- Deprecated `mctb_merge_vars` filter.
#### 1.2.11 - July 8, 2016
**Improvements**
- Completely removed optional jQuery dependency. The plugin now uses JavaScript animations, resulting in a much smoother experience.
#### 1.2.10 - April 12, 2016
**Fixes**
- Closed bar would still overlap underlying elements (like fixed top menu's).
#### 1.2.9 - March 16, 2016
**Fixes**
Top Bar was invisible on some themes because of `z-index` being too low.
#### 1.2.8 - March 15, 2016
**Improvements**
- Make sure top bar doesn't appear on top of WP admin bar.
- Hardened CSS styles for improved theme compatability.
#### 1.2.7 - January 26, 2016
**Improvements**
- Miscellaneous code improvements
**Additions**
- Add support for new [debug log](https://mc4wp.com/kb/how-to-enable-log-debugging/) in MailChimp for WordPress 3.1
#### 1.2.6 - January 4, 2016
**Additions**
- Option to "update existing subscribers" in MailChimp, which is useful if you have added fields.
**Improvements**
- Toggle icon now has a background color, for increased visibility.
- Toggle icon now stacks above or below bar on small screens.
#### 1.2.5 - December 10, 2015
The plugin now requires [MailChimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/) version 3.0 or higher.
**Fixes**
- Fixed column alignment in Appearance tab, thanks [Chantal Coolsma](https://github.com/chantalcoolsma)!
**Improvements**
- Improved admin notice when dependencies are not installed.
#### 1.2.4 - November 22, 2015
- Compatibility for [the upcoming MailChimp for WordPress 3.0 release](https://mc4wp.com/blog/breaking-backwards-compatibility-in-version-3-0/) tomorrow.
- Added `mctb_subscribed` filter.
#### 1.2.3 - November 13, 2015
**Improvements**
- Minor refactoring in the way the plugin is bootstrapped.
#### 1.2.2 - September 10, 2015
**Fixes**
- Honeypot field being auto-completed in some browsers.
- Honeypot field was accessible by pressing "tab" key.
- Hardened security for cookie that tracks sign-up attempts.
#### 1.2.1 - September 8, 2015
**Fixes**
- Response message was not showing for some themes.
**Improvements**
- Better mobile responsiveness
#### 1.2 - September 3, 2015
**Improvements**
- The bar will now auto-dismiss after every successful sign-up.
- Placeholders will now work in Internet Explorer 7, 8 & 9 as well.
**Additions**
- Added options for double opt-in and sending MailChimp's "welcome email".
- Added `mctb_before_label` action allowing you to add HTML before the label-element.
- Added `mctb_before_email_field` action allowing you to add HTML before the email field.
- Added `mctb_before_submit_button` action allowing you to add HTML before the submit button.
- Added `mctb_form_action` filter allowing you to set a custom form action.
#### 1.1.3 - June 23, 2015
**Fixes**
- Fixes fatal error when visiting settings page on some servers
#### 1.1.2 - June 18, 2015
**Improvements**
- Fixes height of response message
- CSS improvements for compatibility with various popular themes
#### 1.1.1 - June 12, 2015
**Fixes**
- Fixes unclickable admin bar (or fixed navigation menu's).
**Improvements**
- Various improvements to bar CSS so it can be easily overridden.
- Fix vertical alignment of toggle icon.
#### 1.1 - June 10, 2015
**Improvements**
- Bar no longer requires jQuery script, saving an additional HTTP request and 100kb
**Additions**
- Position option: top or bottom
- New filter: `mctb_mailchimp_list` (set lists to subscribe to)
- Lithuanian translation, thanks to [Aleksandr Charkov](https://github.com/dec0n)
#### 1.0.8 - May 6, 2015
**Fixes**
- Compatibility with [MailChimp for WordPress Lite v2.3](https://wordpress.org/plugins/mailchimp-for-wp/) and [MailChimp for WordPress Pro v2.7](https://mc4wp.com/).
#### 1.0.7 - April 15, 2015
**Fixes**
- `mctb_show_bar` filter was not functioning properly with some themes.
- Form always errored when using WPML with String Translations.
**Improvements**
- Toggle icon is no longer shown for users without JavaScript.
#### 1.0.6 - March 17, 2015
**Fixes**
- Compatibility issues with latest version of Enfold theme
- Conflict with other plugins shipping _very old_ versions of Composer
**Improvements**
- Allow simple inline tags in the bar text
#### 1.0.5 - February 25, 2015
**Fixes**
- Bar not loading in some themes after latest update
- Colors not working because of missing leading `#` value. Color settings are now validated before saving them.
#### 1.0.4 - February 23, 2015
**Fixes**
- Styling issues with Enfold theme.
**Additions**
- Settings page now uses a tabbed interface.
- You can now set a "redirect url" in the bar settings
- All form response messages can now be customised for the bar form
#### 1.0.3 - February 17, 2015
**Improvements**
- Bar will now show "already subscribed" message from MailChimp for WordPress when a person is already on the selected list.
- Response message will now show and fadeout after 3 seconds.
- Various usability improvements for the settings screen.
- Improved spam detection.
- Major JS performance improvements.
**Additions**
- Multiple new anti-spam measures
- WPML compatibility
#### 1.0.2 - February 12, 2015
**Improvements**
- Better CSS reset for elements inside the bar
- Other minor CSS improvements
**Additions**
- Top Bar sign-ups are now shown in the log for [MailChimp for WordPress Pro](https://mc4wp.com/).
#### 1.0.1 - February 4, 2015
**Fixes**
- The plugin will no longer overlap header menu's or other elements
**Additions**
- You can now set the bar as "sticky", meaning it will stick to the op your window, even when scrolling.
- You can now choose the size of the bar, small/medium/big.
- Added Dutch translation files.
**Improvements**
- The menu item will now show above the item asking you to upgrade to MailChimp for WordPress Pro.
Please update the [MailChimp for WordPress plugin](https://wordpress.org/plugins/mailchimp-for-wp/) before updating to this version.
#### 1.0 - January 28, 2015
Initial release
== Upgrade Notice ==
= 1.2.6 =
Improvements to toggle icon for small screens & dark backgrounds.