readme.txt 14.9 KB
Newer Older
Michael Iseard's avatar
Michael Iseard committed
1
=== Kudos Donations - Easy donations and payments with Mollie ===
2
Contributors: iseardmedia
Michael Iseard's avatar
Michael Iseard committed
3
Tags: donation, mollie, payment, ideal, credit card
4
Requires at least: 5.6
5
Tested up to: 5.8
Michael Iseard's avatar
Michael Iseard committed
6
Requires PHP: 7.2
7
Stable tag: 3.0.0
Michael Iseard's avatar
Michael Iseard committed
8
9
10
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Michael Iseard's avatar
Michael Iseard committed
11
Add a donation button to any page on your website. Easy & fast setup. Works with Mollie payments.
Michael Iseard's avatar
Michael Iseard committed
12
13
14

== Description ==

Michael Iseard's avatar
Michael Iseard committed
15
= A modern and easy to use donation plugin =
Michael Iseard's avatar
Michael Iseard committed
16

Michael Iseard's avatar
Michael Iseard committed
17
*Kudos Donations* allows you to add a donate button anywhere on your website. Once a user clicks this button they will be greeted with a pop-up window where they can enter their details and how much they would like to donate.
Michael Iseard's avatar
Michael Iseard committed
18

Michael Iseard's avatar
Michael Iseard committed
19
20
21
= Features and highlights =

* Smart and modern design.
Michael Iseard's avatar
Michael Iseard committed
22
* One-off or recurring payments.
23
* Can add as many buttons as you like.
Michael Iseard's avatar
Michael Iseard committed
24
* Connect with Mollie for secure payments by credit card, iDEAL and [many others](https://www.mollie.com/payments).
Michael Iseard's avatar
Michael Iseard committed
25
* Toggle Automated email receipts.
Michael Iseard's avatar
Michael Iseard committed
26
27
* Gutenberg block or shortcode to place your button virtually anywhere.
* Customize the donation form, button and thank you message.
Michael Iseard's avatar
Michael Iseard committed
28
* Set a goal and allow donors to see progression.
Michael Iseard's avatar
Michael Iseard committed
29
* View and manage individual transactions, subscriptions, donors and campaigns from the admin menu.
Michael Iseard's avatar
Michael Iseard committed
30
31

= Easy to use =
32
33
34
Just enter your API key from Mollie, then add one or more buttons anywhere on you website. You can add a button using either the provided *Kudos Button* block or with a shortcode. Please see the FAQ below for shortcode use.

Need a Mollie account? Visit their website to [get started](https://www.mollie.com/).
Michael Iseard's avatar
Michael Iseard committed
35

Michael Iseard's avatar
Michael Iseard committed
36
= Campaigns =
Michael Iseard's avatar
Michael Iseard committed
37
Create campaigns to easily group and track donations made by your donors. Each campaign can have a unique configuration which can be changed from the settings page and automatically applied to all your buttons.
Michael Iseard's avatar
Michael Iseard committed
38

Michael Iseard's avatar
Michael Iseard committed
39
= Recurring Payments =
Michael Iseard's avatar
Michael Iseard committed
40
Allow donors to create a donation subscription to support your organization on a regular basis. Kudos Donations will automatically create the subscription and take payments from Mollie. Remember to check that your Mollie account meets the [conditions for recurring payments](https://help.mollie.com/hc/articles/214558045-What-are-the-conditions-for-the-use-of-Recurring-).
Michael Iseard's avatar
Michael Iseard committed
41

Michael Iseard's avatar
Michael Iseard committed
42
43
44
= Source =
The Git repository for this plugin can be found [here](https://gitlab.iseard.media/michael/kudos-donations).

Michael Iseard's avatar
Michael Iseard committed
45
46
== Installation ==

Michael Iseard's avatar
Michael Iseard committed
47
48
49
1. Install using the WordPress plugin control panel or manually download the plugin and upload the *kudos-donations* folder to the /wp-content/plugins/ directory
1. Activate the plugin through the *Plugins* menu in WordPress.
1. Go to the 'Kudos Settings' menu in the dashboard and follow the instructions to get started.
Michael Iseard's avatar
Michael Iseard committed
50
51
52

== Frequently Asked Questions ==

Michael Iseard's avatar
Michael Iseard committed
53
54
= Is Kudos Donations free? =

Michael Iseard's avatar
Michael Iseard committed
55
Yes, Kudos Donations is a free open-source plugin.
Michael Iseard's avatar
Michael Iseard committed
56

Michael Iseard's avatar
Michael Iseard committed
57
= Which payment methods are supported? =
Michael Iseard's avatar
Michael Iseard committed
58

Michael Iseard's avatar
Michael Iseard committed
59
60
61
62
This plugin uses Mollie as a payment vendor. Mollie allows you to pay using a wide range of payment methods such as iDeal, credit card and PayPal. For a full list of payment methods please check out [this link](https://www.mollie.com/en/payments).

= How can I use recurring payments?

Michael Iseard's avatar
Michael Iseard committed
63
In order to use recurring payments Mollie requires that you have either SEPA Direct Debit OR credit card payment methods enabled on your account. For more information visit [this link](https://help.mollie.com/hc/articles/214558045-What-are-the-conditions-for-the-use-of-Recurring-).
Michael Iseard's avatar
Michael Iseard committed
64
65
66
67

= I've enabled the required recurring payment methods but I still cannot use recurring.

If you modified your Mollie account after adding it to Kudos Donations your will need to re-sync the settings. To do this visit the Mollie tab under the settings page and click the "Refresh API" link.
Michael Iseard's avatar
Michael Iseard committed
68

Michael Iseard's avatar
Michael Iseard committed
69
70
71
72
= How much does Mollie cost? =

Mollie registration is free and you only pay a small fee per transaction. See [here](https://www.mollie.com/pricing) for details.

Michael Iseard's avatar
Michael Iseard committed
73
74
75
76
77
78
79
80
= Can anyone use Mollie? =

Mollie is available to anyone with a registered company.

= Can I use Kudos Donations in my country? =

You can use this plugin in any country that is supported by Mollie. For a complete list please see [here](https://help.mollie.com/hc/articles/115002116105-Can-I-use-Mollies-services-in-my-country-)

81
82
= How do I use the shortcode? =

Michael Iseard's avatar
Michael Iseard committed
83
There is a handy "Copy shortcode" button at the bottom of the campaign settings page that will copy the shortcode into your clipboard.
84
85
86
87

To get started add the Kudos Donations shortcode:

~~~
Michael Iseard's avatar
Michael Iseard committed
88
[kudos campaign_id="default"]
89
90
91
92
~~~

Here is a list of the shortcode attributes:

Michael Iseard's avatar
Michael Iseard committed
93
* *button_label* = The label to display for the button.
Michael Iseard's avatar
Michael Iseard committed
94
* *campaign_id* = ID of the campaign to use for this button.
95
96
* *alignment* = Alignment of the button within container. Can be "center", "left" or "right".
* *type* = Whether to show as a button with pop-up or just the form. Can be "button" or "form".
97
98
99
100

e.g:

~~~~
101
[kudos alignment="right" button_label="Donate now" campaign_id="default"]
102
103
~~~~

Michael Iseard's avatar
Michael Iseard committed
104
105
106
107
108
109
For general information on how to use shortcodes, please visit [this page](https://codex.wordpress.org/shortcode).

= The donation modal (pop-up) does not appear correctly. =

This can occur as a result of a conflict with your theme or another plugin and the solution can be different for each website. A quick and easy fix to try is to enable the "Modal in footer" option under the help tab in settings.

Michael Iseard's avatar
Michael Iseard committed
110
111
== Screenshots ==

Michael Iseard's avatar
Michael Iseard committed
112
1. Donation form
Michael Iseard's avatar
Michael Iseard committed
113
2. Recurring/Subscription payments
Michael Iseard's avatar
Michael Iseard committed
114
115
116
117
3. Goal progression
4. Settings page
5. Kudos Donations button block
6. Automated email receipt
Michael Iseard's avatar
Michael Iseard committed
118
119
120

== Changelog ==

121
122
= 3.1.0 =
* *NEW* Spam protection option (enabled by default). Automatically adds a honeypot field and timer for form to prevent/reduce spam.
Michael Iseard's avatar
Michael Iseard committed
123
* *NEW* Improved "Welcome Guide" making it easier to get started with Kudos Donations
Michael Iseard's avatar
Michael Iseard committed
124
* Option to disable [kudos] shortcode. If not needed this will prevent CSS/JS from loading when not needed.
125
* Upgrade to Block API version 2. This increases the min WordPress version to 5.6.
126
* Simplify completed payments settings (it is no longer possible to have a custom return url AND a pop-up message)
127
* Change logging to database storage
128
129
130
* Add "Clear object cache" to debug actions
* Add white background to form elements
* Rearrange debug actions page
131
132
133
* Update Mollie API client to 2.37.1
* Update ActionScheduler to 3.3.0
* Update TailwindCSS to 2.2.16
134
135
136
* Minor block bug fixes

= 3.0.0 =
137
* *NEW* You can now add a donation form without using a button or popup. This can be selected in the side panel when placing a Kudos block, or if using the shortcode by adding the attribute type="form".
138
139
* *NEW* Allow adding additional funds to campaign. Useful if you receive donations for your campaign outside of Kudos.
* *NEW* Add ability to choose custom theme color.
Michael Iseard's avatar
Michael Iseard committed
140
141
* Log file is cleared once it reaches 2MB.
* Implementation of dependency injection using PHP-DI. This will result in faster, cleaner and easier to maintain code.
Michael Iseard's avatar
Michael Iseard committed
142
* Switch to Laravel-Mix for building assets.
143
* Move goal icon in front of goal amount.
144
145
146
* Update Mollie API client to 2.36.1
* Update ActionScheduler to 3.2.1
* Update TailwindCSS to 2.2.4
Michael Iseard's avatar
Michael Iseard committed
147
* Update Monolog to 2.3.1
Michael Iseard's avatar
Michael Iseard committed
148

Michael Iseard's avatar
Michael Iseard committed
149
150
151
152
153
154
155
156
= 2.7.0 =
* Add goal progression to campaigns. Disabled by default, this can be enabled per campaign and shows a percentage bar of how much the campaign has already raised as well as how much the currently selected amount will progress the campaign.
* Improve navigation buttons on mobile
* Upgrade TailwindCSS to 2.1.4
* Upgrade Mollie API client to 2.32.0 (reduces plugin filesize)
* Upgrade Action Scheduler to 3.2.0
* Fix amount not resetting if Amount type "Open" selected

Michael Iseard's avatar
Michael Iseard committed
157
= 2.6.0 =
158
* Improve look and use on mobile
Michael Iseard's avatar
Michael Iseard committed
159
160
* Increase size on larger screens
* Add option to place donate modal markup in footer (for compatibility troubleshooting)
Michael Iseard's avatar
Michael Iseard committed
161
* Accessibility related improvements
Michael Iseard's avatar
Michael Iseard committed
162
* Add asterisk to required fields
Michael Iseard's avatar
Michael Iseard committed
163
* Pressing enter on form now same as clicking 'next' button
164
* Add more missing translation function calls
Michael Iseard's avatar
Michael Iseard committed
165
166
167
* Fix uncaught exception on transactions table if campaign empty
* Fix empty line in address if no business name (Donors table)

Michael Iseard's avatar
Michael Iseard committed
168
169
170
171
172
173
174
= 2.5.1 =
* Add missing translation function calls
* Fix payment cancelled message not appearing
* Improve subscription cancellation logic
* Replace deprecated array_key_exists function
* Various minor visual tweaks

Michael Iseard's avatar
Michael Iseard committed
175
= 2.5.0 =
Michael Iseard's avatar
Michael Iseard committed
176
* Add optional "message" field to donation form. This can be enabled per campaign under "Campaign details".
Michael Iseard's avatar
Michael Iseard committed
177
* Change 'country' field to drop-down select
Michael Iseard's avatar
Michael Iseard committed
178
* Change 'back' and 'close' icon colors on modal to grey
Michael Iseard's avatar
Michael Iseard committed
179
* Fix missing screen options pull-down on table pages
Michael Iseard's avatar
Michael Iseard committed
180
* Upgrade TailwindCSS to 2.1.2
Michael Iseard's avatar
Michael Iseard committed
181
182
* Upgrade Twig 2 to Twig 3
* Upgrade Mollie API client to 2.31.1
Michael Iseard's avatar
Michael Iseard committed
183
* Change minimum PHP version to 7.2
Michael Iseard's avatar
Michael Iseard committed
184
* Switch from node-sass to Dart Sass
Michael Iseard's avatar
Michael Iseard committed
185
* Switch to using sanitize_callbacks to sanitize all rest data
Michael Iseard's avatar
Michael Iseard committed
186

187
= 2.4.7 =
188
189
* Various visual tweaks to the donation form
* Add 'backface-visibility' css rule to logo to ensure it remains visible when animating
Michael Iseard's avatar
Michael Iseard committed
190
191
* Fix some buttons on settings page not animating when busy
* Revert to using css rule 'initial' instead of 'unset' to avoid style clashes
192
193
* Resolve jQuery.fn.focus() event shorthand deprecation
* Update dependencies
194

Michael Iseard's avatar
Michael Iseard committed
195
= 2.4.6 =
Michael Iseard's avatar
Michael Iseard committed
196
* Add error message if campaign not found or Mollie not connected, displayed on front end and only to admins
Michael Iseard's avatar
Michael Iseard committed
197
198
199
200
* Add icon to 'select' form elements
* Fix campaign id sometimes changing on save
* Fix subscriptions allowing a total of 1 payment being created when using multiple buttons per page
* Change new campaign donation type to 'One-off'
Michael Iseard's avatar
Michael Iseard committed
201
* Tweak logo animation
Michael Iseard's avatar
Michael Iseard committed
202
203
* Update dependencies

Michael Iseard's avatar
Michael Iseard committed
204
= 2.4.5 =
205
* Fix clash with jQuery
Michael Iseard's avatar
Michael Iseard committed
206
207
* More logging improvements

Michael Iseard's avatar
Michael Iseard committed
208
209
= 2.4.4 =
* Accessibility improvements
Michael Iseard's avatar
Michael Iseard committed
210
* Improve javascript to avoid conflicts
Michael Iseard's avatar
Michael Iseard committed
211
* Reduce size of public-facing javascript file
Michael Iseard's avatar
Michael Iseard committed
212
* Correct typo on address slide
Michael Iseard's avatar
Michael Iseard committed
213

Michael Iseard's avatar
Michael Iseard committed
214
= 2.4.3 =
Michael Iseard's avatar
Michael Iseard committed
215
* Increase CSS selector specificity to help prevent clashes with theme/plugins
Michael Iseard's avatar
Michael Iseard committed
216
* Reduce number of css files and overall size
217
* Add "Secure payment by Mollie" to payment page
Michael Iseard's avatar
Michael Iseard committed
218
219
* First value field now in focus when modal opened
* Upgrade jquery-validation to 1.19.3 - fixes deprecation warnings
Michael Iseard's avatar
Michael Iseard committed
220

Michael Iseard's avatar
Michael Iseard committed
221
222
= 2.4.2 =
* Improve settings sanitization
Michael Iseard's avatar
Michael Iseard committed
223
* Fix query var handling for front-end kudos_action
Michael Iseard's avatar
Michael Iseard committed
224
225
226
* Logging improvements
* Upgrade Twig to 2.14.4

Michael Iseard's avatar
Michael Iseard committed
227
228
229
= 2.4.1 =
* Fix migration issue with Mollie connected status

Michael Iseard's avatar
Michael Iseard committed
230
231
232
233
234
= 2.4.0 =
* Add API check for Mollie recurring payments ability. Please see [here](https://help.mollie.com/hc/articles/214558045-What-are-the-conditions-for-the-use-of-Recurring-) for more detail.
* Add additional theme colours
* Change default donation type to oneoff
* Improve campaign settings sanitization
Michael Iseard's avatar
Michael Iseard committed
235
* Fix critical error when incorrect API key format used
Michael Iseard's avatar
Michael Iseard committed
236
* Fix minor theme inconsistencies
Michael Iseard's avatar
Michael Iseard committed
237
* Move Mollie settings to serialized array
Michael Iseard's avatar
Michael Iseard committed
238
* Added more debug actions / debug page now accessible without being enabled
Michael Iseard's avatar
Michael Iseard committed
239
240
241

= 2.3.8 =
* Allow more flexibility in translation of 'I agree' boxes
Michael Iseard's avatar
Michael Iseard committed
242

Michael Iseard's avatar
Michael Iseard committed
243
= 2.3.7 =
Michael Iseard's avatar
Michael Iseard committed
244
245
246
247
* Add separate "privacy policy" option
* Update Mollie API client
* Fix translation error
* Fix incorrect business name database constraint
Michael Iseard's avatar
Michael Iseard committed
248

Michael Iseard's avatar
Michael Iseard committed
249
250
251
252
= 2.3.6 =
* Compatibility with WordPress 5.7
* Filter improvements

Michael Iseard's avatar
Michael Iseard committed
253
254
= 2.3.5 =
* Fix settings import
Michael Iseard's avatar
Michael Iseard committed
255
* Update TailwindCSS to 2.0.3
Michael Iseard's avatar
Michael Iseard committed
256

Michael Iseard's avatar
Michael Iseard committed
257
258
= 2.3.4 =
* Add 'Business name' to address fields
259
* Fix campaign table warnings
Michael Iseard's avatar
Michael Iseard committed
260
261
262
* Combine Advanced/Help settings tabs
* Minor improvements to Mollie settings
* Improvements to REST routes
Michael Iseard's avatar
Michael Iseard committed
263

264
265
266
267
= 2.3.3 =
* Fix address fields not showing
* Improve settings defaults for campaign and theme

Michael Iseard's avatar
Michael Iseard committed
268
269
270
271
272
= 2.3.2 =
* Add 'goal' to campaigns
* Further improvements to subscription cancellation
* Update hooks and filters

Michael Iseard's avatar
Michael Iseard committed
273
274
= 2.3.1 =
* Display campaign_id in campaign header on settings page
Michael Iseard's avatar
Michael Iseard committed
275
276
277
* Fix issues with canceling subscriptions
* Fix various missing translations caused by webpack compression
* Various other minor fixes
Michael Iseard's avatar
Michael Iseard committed
278

Michael Iseard's avatar
Michael Iseard committed
279
= 2.3.0 =
280
* Reworked campaigns, greatly simplifying shortcodes and configuration
Michael Iseard's avatar
Michael Iseard committed
281
* Improved settings page
Michael Iseard's avatar
Michael Iseard committed
282
283
* Switch to REST api to create transactions
* Added welcome guide when settings page first visited
Michael Iseard's avatar
Michael Iseard committed
284
* Added "Help" tab to settings page with useful links
Michael Iseard's avatar
Michael Iseard committed
285
286
* Fixed issue with email used in test mode not working in live
* Fixed issue with email when "From address" left blank
Michael Iseard's avatar
Michael Iseard committed
287

Michael Iseard's avatar
Michael Iseard committed
288
= 2.2.0 =
289
* Add ability to change donation type (subscription, one-off or both) to each button
Michael Iseard's avatar
Michael Iseard committed
290
* Add ability to export/import settings
291
292
* Terms and conditions checkbox not shown if no URL provided in settings
* Remove hook for clearing log as this did not work consistently
293
* Fix transactions link on campaigns page
294
* Various text/translation fixes
Michael Iseard's avatar
Michael Iseard committed
295

Michael Iseard's avatar
Michael Iseard committed
296
297
298
299
= 2.1.1 =
* Fix missing Dutch translations
* Remove unnecessary option to disable Action Scheduler

Michael Iseard's avatar
Michael Iseard committed
300
= 2.1.0 =
Michael Iseard's avatar
Michael Iseard committed
301
* Add option to select 'both' for amount type
Michael Iseard's avatar
Michael Iseard committed
302
* Workaround to fix missing translations from translate.wordpress.org
303
* Log is now cleared every midnight
Michael Iseard's avatar
Michael Iseard committed
304
* Fix issues with payments over 999
Michael Iseard's avatar
Michael Iseard committed
305
306
* Fix email address not validating correctly
* Fix various jQuery deprecations
307
* Fix twig cache issue by clearing cache on activation
Michael Iseard's avatar
Michael Iseard committed
308

Michael Iseard's avatar
Michael Iseard committed
309
= 2.0.8 =
Michael Iseard's avatar
Michael Iseard committed
310
311
* Add 'Recreate database' action to debug menu
* Add confirmation pop-up to debug actions
Michael Iseard's avatar
Michael Iseard committed
312
* Update libraries
Michael Iseard's avatar
Michael Iseard committed
313
314
* Minor bug fixes

Michael Iseard's avatar
Michael Iseard committed
315
316
317
= 2.0.7 =
* Campaign label no longer defaults to page/post title
* Improve look of fixed amount buttons (now limited to 4)
318
319
* Fix REST_API error for mollie/admin in WordPress 5.6
* Fix some visual changes introduced in Twenty Twenty-One
Michael Iseard's avatar
Michael Iseard committed
320
321
322
* Text changes
* Minor bug fixes

Michael Iseard's avatar
Michael Iseard committed
323
324
= 2.0.6 =
* Fix unknown index errors on tables
Michael Iseard's avatar
Michael Iseard committed
325
326
* Fix 'Sync campaign labels' action adding blank campaigns
* Update TailwindCSS to 2.0.1
Michael Iseard's avatar
Michael Iseard committed
327
* Update Dutch translations
Michael Iseard's avatar
Michael Iseard committed
328

Michael Iseard's avatar
Michael Iseard committed
329
330
= 2.0.5 =
* Fixed error deleting donors
Michael Iseard's avatar
Michael Iseard committed
331
* Fix slashes appearing in address
332
333
334
335
* Add select column for table search
* Add 'Last Donation' column to campaign table
* Add debug option to sync campaigns
* Add more Dutch translations
Michael Iseard's avatar
Michael Iseard committed
336
* Add more hooks
337
338
* Use object cache for database queries
* Improve debug logging
Michael Iseard's avatar
Michael Iseard committed
339

Michael Iseard's avatar
Michael Iseard committed
340
341
342
343
= 2.0.4 =
* Added campaigns table
* New campaign block settings allows you to select previous campaigns or add new one

Michael Iseard's avatar
Michael Iseard committed
344
= 2.0.3 =
Michael Iseard's avatar
Michael Iseard committed
345
* Fix modal header not showing correct text
Michael Iseard's avatar
Michael Iseard committed
346
* Fix translations
Michael Iseard's avatar
Michael Iseard committed
347
* Fix debug actions not redirecting to correct tab
Michael Iseard's avatar
Michael Iseard committed
348

Michael Iseard's avatar
Michael Iseard committed
349
350
351
352
= 2.0.2 =
* Add ability to search by campaign in transactions table
* Update Dutch translation

Michael Iseard's avatar
Michael Iseard committed
353
354
355
= 2.0.1 =
* Add ability to clear twig cache from the debug menu

Michael Iseard's avatar
Michael Iseard committed
356
357
= 2.0.0 =
* *Plugin completely rewritten*
Michael Iseard's avatar
Michael Iseard committed
358
* Significantly reduced size and increased speed
Michael Iseard's avatar
Michael Iseard committed
359
360
361
362
363
* Brand new settings page built on React
* Ability for customers to create subscriptions
* Ability to switch between open and fixed donation amounts
* Action scheduler integration for quicker payments/emails

364
365
= 1.1.0 =
* *Added* - Email receipts - You can now configure email server settings and enable automatic email receipts
Michael Iseard's avatar
Michael Iseard committed
366
* *Added* - Invoices - PDFs now generated for each successful transaction and are available from the transactions table
367
* *Added* - Donor search bar to transactions
Michael Iseard's avatar
Michael Iseard committed
368
* *Fixed* - Input checks for API Key type
369

Michael Iseard's avatar
Michael Iseard committed
370
371
372
373
374
375
376
= 1.0.2 =
* *Added* - transactions table now shows record count per filter
* *Added* - return message now shows currency symbol
* *Fixed* - if log file cannot be written this no longer prevents plugin from working
* *Fixed* - export now only exports transaction in current view (all/live/test)
* *Fixed* - incorrect record count on transaction table

Michael Iseard's avatar
Michael Iseard committed
377
378
379
= 1.0.1 =
* *Added* - ability to export transactions
* *Fixed* - missing defaults from Kudos button block
Michael Iseard's avatar
Michael Iseard committed
380
* *Fixed* - missing Dutch translations
Michael Iseard's avatar
Michael Iseard committed
381

Michael Iseard's avatar
Michael Iseard committed
382
= 1.0 =
Michael Iseard's avatar
Michael Iseard committed
383
* Initial release