forked from humanmade/wp-stripe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
236 lines (149 loc) · 7.73 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
=== WP Stripe ===
Contributors: humanmade, Noel_Tock, willmot
Donate link: http://www.noeltock.com
Tags: stripe, paypal, payment, pay, transfer, charge, widget, form, chargly, recurly, gravatar, avatar, recent, donation, donations, charity, transaction, money
Requires at least: 3.1
Tested up to: 3.9
Stable tag: 1.5
WP Stripe provides a payment form and recent donor widget by utilizing Stripe.com, the awesome alternative to PayPal.
== Description ==
= Introduction =
WP Stripe is a plugin designed to handle **single payments** using [Stripe](http://www.stripe.com/), a refreshing and accessible alternative to PayPal. This is particularly awesome for charities, non-profit organizations and other websites accepting smaller payments where transaction fees are unnecessarily high (no setup or monthly fees either).
= Will it work on my Theme? =
**Yes!** WP-Stripe features an inline form or pop-up modal so that it can fit any theme. There's also a simple option to turn off the default CSS so that you can customize it yourself.
= Features =
This plugin allows you to do a number of things (see screenshots too):
* Add a **Donation/Payment Form** via Shortcode or Template insert
* Add a Widget showing Recent Donations/Payments (using Gravatars)
* View latest Donations/Payments in a Widget (donors can opt-in/opt-out).
* View latest Donations/Payments in a WP-Admin (makes use of custom post types to store transactions without sensitive data, see FAQ for more information).
= Using SSL (Important) =
In order to process transactions in a secure manner, you need to [purchase an SSL Certificate](http://www.noeltock.com/sslcertificates/). This way consumers can purchase/donate with confidence. There are multiple plugins for then enforcing that SSL be used on your page, [here's one](http://wordpress.org/extend/plugins/wordpress-https/).
= Stripe Limitations =
Stripe is available in a number of countries, [check here](https://stripe.com/global) to see if your country is supported.
= Updates =
Follow us for updates at [@humanmadeltd](http://www.twitter.com/humanmadeltd)
== Installation ==
WP Stripe can be used by either calling up a simple shortcode or adding the function to your template as below:
1. Upload the folder `wp-stripe` to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Go to Settings -> WP Stripe and add your API Keys (for both Test & Live)
1. Place `[wp-stripe]` in your content or `<?php wp_stripe_form(); ?>` in your template.
1. Add the `Stripe - Recent` widget to show recent payments/donations.
= IMPORTANT (SSL) =
In order to process transactions in a secure manner, you need to [purchase an SSL Certificate](http://www.noeltock.com/sslcertificates/). This way consumers can purchase/donate with confidence. There are multiple plugins for then enforcing that SSL be used on your page, [here's one](http://wordpress.org/extend/plugins/wordpress-https/).
== Frequently Asked Questions ==
= How does WP Stripe work ? =
WP Stripe uses a simple to add form to capture person & payment details. Credit card information is then passed to the Stripe servers in the form of a token, increasing security and hindering duplication.
= What information does WP Stripe store? =
WP Stripe **DOES** store basic transaction data (Transaction ID, Amounts & User Data that was voluntarily provided by the donor).
WP Stripe **DOES NOT** store credit card information. Upon form submission, a token is generated by `stripe.js` and passed through POST and then on to the stripe servers, that is the extent of it.
= Does WP Stripe offer a shopping cart module? =
WP Stripe is not intended to be used as an e-commerce solution, but rather to handle single payments and donations.
= Does WP Stripe offer any actions or filters? =
Actions
* `wp_stripe_post_successful_charge` (after a successful charge and saving to WP)
* `wp_stripe_post_fail_charge` (after a failed charge, for whatever reason)
Filter
* `wp_stripe_filter_form`(to filter/edit the content of the form)
== Screenshots ==
1. Payment Form
2. Payments Overview
3. Recent Payments Widget (largely unstyled, shows recent donations of users who opted-in)
== Changelog ==
= 1.5 =
* Tested for latest version of WordPress (3.9)
* Tested for latest version of Stripe
* Various security fixes/enhancements
* Enchanced submit button with progress state
* Fixed Close button
* Fixed UI bugs within WP-Admin
* Update to latest version of Stripe PHP library
* Updated ReadMe
= 1.4.7 =
* Added admin option for other currencies supported by Stripe
* Fixed issue with commas in amount (e.g. $1,000)
= 1.4.6 =
* Added Actions & Filters (for successful/failed charges and form output). Will allow you to add functions such as confirmation e-mails.
* Fixed bug with comments/widget
* Updated Stripe PHP
= 1.4.5 =
* Enhanced description sent to Stripe to include e-mail
* Moved widget quotes to CSS (as opposed to being hardcoded)
* Put in safeguard to strip out any '$' symbols dropped in from end-user (for amount field)
* Added conditional to only show "Display on Website" if widget is also ticked
= 1.4.4 =
* Fix for deprecated charge/amount
* Fix for American Express CVC
= 1.4.3 =
* Fix issue where Stripe php class is conflicting
* Fix z-index issue
= 1.4.2 =
* AJAX Fix
= 1.4.1 =
* Security Fix
* SSL Option for Modal
* Updated Stripe PHP
* Ability to page through transactions (i.e. next/previous page, not limited to 50 anymore)
= 1.4.0 =
* Updated Stripe PHP
* Tested for WordPress 3.4
* Optimized/Refactored jQuery
* Replaced standard POST submission through AJAX (no more page switches)
* Enhanced form to use HTML5 form UI elements that are built within browsers (i.e. required, autofocus, maxlength, etc.)
* Validates as HTML5
* Added NONCE security check
* Cleaned up iFrame, provided proper headers
= 1.3.3 =
* Updated Stripe PHP
* Allow button shortcode anywhere on website (as opposed to only on page)
* Better submit state
* Notification Fix
= 1.3.2 =
* Remove function
= 1.3.1 =
* Quick fix for sites running older PHP
= 1.3 =
* Added Pop-up / Modal Box for making a payment (better plug & play), you can still use the inline form with `[wp-legacy-stripe]`
* Added cards accepted below button, to disable use `[wp-stripe cards="false"]`
* Simple Form Validation
* "Submit Payment" button is replaced with spinner onclick (avoids multiple clicks)
* Added Button on transactions page to delete all Test transactions
* Added Name of person paying to Stripe charge
* Fix: Issue with Shortcode bumping to the top of a page
* Fix : CSS Hardening of Form (to make it more compatible with your theme)
= 1.2 =
* Small fix
= 1.1 =
* Few ReadMe Tweaks
= 1.0 =
* Initial Release
* Added Stripe Payment Form
* Added Stripe Recent Donations Widget (users can opt-in/out)
* Added Stripe Transaction Overview in WP-Admin
== Upgrade Notice ==
= 1.5 =
* Big update, security enhancements, bug fixes and more
= 1.4.6 =
* Added Actions & Hooks, and more (see changelog)
= 1.4.5 =
* Various Enhancements (see changelog)
= 1.4.4 =
* Important fix (Stripe deprecated it's previous way of pushing the amount)
= 1.4.3 =
* Conflict fix, important if you were getting an error before.
= 1.4.2 =
* AJAX fix, important.
= 1.4.1 =
* Security fix and other tweaks.
= 1.4.0 =
* Number of enhancements and WP 3.4 Upgrade (no need to configure anything upon update)
= 1.3 =
* This will change the display of your current stripe shortcode to a button that will pop up a modal box. You can continue using the old form within your content by using: `[wp-legacy-stripe]`
= 1.2 =
* Small fix
= 1.1 =
* Few ReadMe Tweaks
= 1.0 =
== Feedback & Bugs ==
As this is a new plugin, there are likely to be a few issues. Kindly post any issues, questions or suggestions on the [WP-Stripe forums](http://wordpress.org/support/plugin/wp-stripe) .