forked from EvanHerman/yikes-inc-easy-mailchimp-extender
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
209 lines (153 loc) · 14.4 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
=== Easy Forms for Mailchimp ===
Contributors: yikesinc, eherman24, liljimmi, JPry, yikesitskevin, fmixell, vochr
Donate link: https://yikesplugins.com/?utm_source=wp_plugin_repo&utm_medium=donate_link&utm_campaign=easy_forms_for_mailchimp
Tags: Mailchimp, Mailchimp forms, Mailchimp lists, opt-in forms, sign up form, Mailchimp, email, forms, mailing lists, marketing, newsletter, sign up
Requires at least: 4.0
Tested up to: 5.5
Requires PHP: 5.2.13
Stable tag: 6.8.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
The ultimate Mailchimp WordPress plugin. Easily build unlimited forms for your Mailchimp lists, add them to your site and track subscriber activity.
== Description ==
Easy Forms for Mailchimp allows you to add **unlimited** Mailchimp sign up forms to your WordPress site. You can add forms to posts, pages, sidebars and other widgetized areas. Your Mailchimp API Key connects your site to your account and pulls in all of your list information. List statistics can be viewed right from your dashboard.
> Note: For assistance with GDPR compliance, use our free add-on [GDPR Compliance for Mailchimp](https://wordpress.org/plugins/eu-opt-in-compliance-for-mailchimp/).
You can also extend the plugin's functionality with our [free and paid add-ons](https://yikesplugins.com/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp).
**Add a form to a site in a minute and a half**
https://www.youtube.com/watch?v=NRZbW-Da1XA
**Features**
* Build **unlimited** forms for any of your lists with an easy-to-use admin, including multiple forms for the same list.
* Connect your website to your Mailchimp account with an API key.
* Add forms to any post or page with our editor button or a shortcode.
* Duplicate forms with a click.
* Customize the form submission button text.
* Display forms with inline fields.
* Add forms to widgetized areas with our widget.
* Allow users to sign up for interest groups, or pre-check groups in a hidden field.
* Use our built-in CSS classes or add your own additional classes to form fields to style and customize forms.
* Use a shortcode to display the number of subscribers on a given list.
* Fully customize the success and error messages displayed back to the user.
* Quickly toggle between single or double opt-in.
* Disable or Enable the default welcome email.
* Remove subscribers from your list through our admin interface.
* Allow existing subscribers to update their profile information.
* Redirect users to another post or page after form submission.
* Enable Google reCAPTCHA protection on your forms.
* Schedule form visibility by date/time.
* Limit opt-ins by logged in users.
* Use localized data/time pickers
* Toggle on/off AJAX functionality on a per form basis.
* Import/Export all forms and associated settings for use on other sites with the plugin installed.
* Integrate with core WordPress forms: comments and registration.
* Integrate with many popular third party plugins: WooCommerce, Easy Digital Downloads, BuddyPress, BbPress, Contact Form 7.
* View your account activity like subscribes and unsubscribes.
* View your list statistics and manage users and list settings.
* Use advanced debugging to log errors as they occur, for easy troubleshooting.
* Developer friendly! Use our many hooks and filters to extend the plugin.
* Add-ons available to extend the core functionality of the plugin. [Check them out](https://yikesplugins.com/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp)!
**Integrations**
Add Mailchimp opt-in checkboxes to the forms generated by these popular plugins.
* WooCommerce
* Easy Digital Downloads
* BuddyPress
* BbPress
* Contact Form 7
Instructions on how to use the plugin can be [found in our Knowledge Base](https://yikesplugins.com/support/knowledge-base/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp).
If you experience any problems, please submit a New Issue on our [Github Issue Tracker](https://github.com/yikesinc/yikes-inc-easy-mailchimp-extender/issues). We respond to issues regarding the free plugin within a week. For expedited help, [purchase one of our paid add-ons](https://yikesplugins.com/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp).
<br />
<em>Check out some of our [other plugins](https://yikesplugins.com/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp).</em>
== Installation ==
1. Download the plugin .zip file and make note of where on your computer you downloaded it to.
2. In the WordPress admin (example.com/wp-admin) go to Plugins > Add New or click the "Add New" button on the main plugins screen.
3. On the following screen, click the "Upload Plugin" button.
4. Browse your computer to where you downloaded the plugin .zip file, select it and click the "Install Now" button.
5. After the plugin has successfully installed, click "Activate Plugin" and enjoy!
Visit [our Knowledge Base](https://yikesplugins.com/support/knowledge-base/how-to-install-the-plugin-2/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp) for more detailed installation instructions.
== Frequently Asked Questions ==
**All documentation can be found in [our Knowledge Base](https://yikesplugins.com/support/knowledge-base/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp).**
= Do I need a Mailchimp account to use this plugin? =
Yes, you must have a Mailchimp account and at least 1 list set up in order to use the plugin. You can register for one for free at [their website](https://login.mailchimp.com/signup?).
= How does the plugin connect my Mailchimp account to my site? =
Our plugin uses an API Key to allow your site to communicate with your account. After you enter your API key into the plugin settings your site is connected to your account and ready to make forms.
= How do I create a Mailchimp API key? =
Step-by-step instructions:
1. Click your profile name to expand the Account Panel, and choose Account.
2. Click the Extras drop-down menu and choose Mailchimp API keys.
3. Copy an existing API key or click the Create A Key button.
4. Name your key descriptively, so you know what application uses that key.
Copy your API key so you can paste it into the plugin General Settings.
= How do I make my forms GDPR compliant? =
For assistance with GDPR compliance, use our free add-on [EU Opt-In Compliance for Mailchimp](https://wordpress.org/plugins/eu-opt-in-compliance-for-mailchimp/).
= How do I change the submit button text? =
The submit button text can be customized to use any text you like. This is done via the shortcode. Please visit our How-to article [How do I change the submit button text](https://yikesplugins.com/support/knowledge-base/how-do-i-change-the-submit-button-text/) for step-by-step instructions.
= How do I add new fields to my form? =
The fields that are assigned to a list are managed on the Mailchimp site. To add or remove fields you need to log in to your account and manage them there.
Please read the article [Manage List and Sign Up Form Fields](http://kb.mailchimp.com/lists/managing-subscribers/manage-list-and-signup-form-fields) to learn how to add and edit the fields for your lists.
After you’ve added fields, they may not show up immediately in our plugin’s Form Builder. Our plugin pulls the information from your lists and stores it for a period of time before pulling it again. To get the new information immediately you will need to clear the Mailchimp API cache. Please read our article [API Cache Settings](https://yikesplugins.com/support/knowledge-base/api-cache-settings/) for instructions on how to clear the Mailchimp API cache.
= How do I change the field labels? =
The text next to or above each field of a form is called a “label” and you may want to change them. For instance by default Mailchimp uses “First” instead of “First Name” and you may want to change it to make more sense. In the form builder, you will find a little pencil icon next to each form label. Click that icon to edit the label and hit the check icon to save it. After you are done editing field labels you will need to hit the "Update Form" button to save all of your changes.
= I’m not seeing all my lists on the drop-down menu when I go to make a new form, why? =
Our plugin fetches your list information from your account and stores it on your site in a cache. If you make changes to your lists, our plugin will update your site with those changes within an hour. If you want it updated immediately (for instance if you add a new list), you can delete the cache. Please read [our Knowledge Base Article](https://yikesplugins.com/support/knowledge-base/im-not-seeing-all-my-lists-on-the-drop-down-menu-when-i-go-to-make-a-new-form/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp) for more info.
= Is there a way to display the number of subscribers for a given list? =
Yes! You can use the shortcode, `[yikes-mailchimp-subscriber-count]` in the form description field to display the number of subscribers to that list.
To display the count for a specific list, you can use the `form="#"` or `list="#"` parameters. If using `form="#"` you should pass in a specific form ID, which will display the total number of subscribers associated with that form. If using `list="#"` you should pass in a list ID.
= I want to use my own styles. Can I remove the styles bundled with this plugin? =
Yes, we've included a constant you can use to prevent our styles from loading, `YIKES_MAILCHIMP_EXCLUDE_STYLES`. For usage, please see [our Knowledge Base Article](https://yikesplugins.com/support/knowledge-base/how-do-i-deregister-the-styles-included-with-this-plugin/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp).
= Some of the characters in my form are being stored as ??? instead of in the correct format. =
You'll want to make sure that your database collation is set properly. The best collation setting for all web languages is UTF8. If you need help switching collation settings in your database, please see the following article from Media Temple: [Default MySQL character set and collation](https://mediatemple.net/community/products/dv/204403914/default-mysql-character-set-and-collation).
= I'm having trouble upgrading to version 6, what do I do? =
We want our users to have as smooth a transition as possible so we created [Guides to Updating](https://yikesplugins.com/support/knowledge-base/product/installation-easy-forms-for-mailchimp/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp). Please check them out if you are experiencing problems.
= Can I define my API key using a PHP constant, inside of wp-config.php? =
Yes! Since version 6.1.2 we have enabled the ability to define a PHP constant inside of wp-config.php to be used throughout the plugin. The constant name you'll want to use is `YIKES_MC_API_KEY`. Once you've defined your constant, you'll want to head into the options page and save your settings for the changes to take hold.
Example:
`define( 'YIKES_MC_API_KEY', '12345679-us2' );`
== Screenshots ==
1. General Form Settings - Enter your API key to connect your site to your account
2. Manage Forms Page - See all the forms you have created for your lists and create new forms
3. Form Editor Page - Build, edit and adjust the settings for your forms
4. Form Field Options - Set a variety of options for each form field
5. Form Opt-In and Submission Settings - Set the options for each form
6. Account Overview Page - View your account activity
7. Integration Settings - Integrate opt-in checkboxes with other forms
8. reCAPTCHA Settings - Add a Google reCAPTCHA key
9. Account Activity Dashboard Widget - View your account activity
10. List Stats Dashboard Widget
11. List Information Screen
12. Subscriber Details Screen
13. Form Widget
14. Form Widget in the Sidebar on Live Website
15. Editor Button to easily add Forms to Page and Posts
16. Form on a Page on Live Website
17. Additional Form Settings
18. Inline Form on a Page on Live Website
== Other Notes ==
Alongside the default functionality of the plugin we've included a number of hooks and filters to allow for a higher level of customization of your forms.
For information and code examples on how to implement the hooks and filters provided by our plugin, please see our [Developer Documentation in the Knowledge Base](https://yikesplugins.com/support/knowledge-base/product/developer-documentation/?utm_source=wp_plugin_repo&utm_medium=link&utm_campaign=easy_forms_for_mailchimp).
== Changelog ==
= 6.8.0 - September, 14, 2020 =
* Added 'Placeholder' for dropdown.
* Patched bug for checkbox interest group.
= 6.7.0 - July, 1, 2020 =
* Adding support for Google Recaptcha Version 3.
= 6.6.4 - March, 26, 2020 =
* Fixes "Freddie" logo image path.
= 6.6.3 - February, 27, 2020 =
* Important security release.
= 6.6.2 - November, 3, 2019 =
* Bug scrub WCUS! Fixed issues with adding tags on resubscribe.
= 6.6.0 - October 25, 2019 =
* Adding Double Opt-in Subscribe.
* Easy Forms Gutenberg Category - Thanks to @Ajwerth.
= 6.5.6 - October 24, 2019 =
* Fixing bug with WordPress 5.3 ahead of release.
= 6.5.4 - August 28th, 2019 =
* Patched security vulnerability found in on of our dependencies.
= 6.5.3 - July 1st, 2019 =
* Added support for showing whether your site is being blocked by Mailchimp. If you're blocked, you will now see an error on the plugin's General Settings page.
* Added a filter for our checkbox integrations, `yikes_mailchimp_checkbox_integration_additional_vars`. This allows you to use custom variables in our other filters.
* Added a filter for changing the placement (above/below/both) of form error/success messages. See the filter `yikes_mailchimp_feedback_message_placement`.
* Added support for setting the timestamp_signup Mailchimp merge variable to all new subscribers.
* Removed support for setting the timestamp_opt variable for all subscribers. This plugin will no longer set the timestamp_opt Mailchimp merge variable.
* Fixed an issue with default selected interest groups not working in our Gutenberg block.
* Fixed admin input field code injection vulnerability. Thanks to Henri Salo from Nixu Corporation for finding and reporting this to us.
* Fixed an error w/ error handling a failed API hit on the Manage Lists page.