forked from woocommerce/woocommerce
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
241 lines (171 loc) · 16.2 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
=== WooCommerce ===
Contributors: automattic, mikejolley, jameskoster, claudiosanches, jshreve, coderkevin, claudiulodro, woothemes, iCaleb
Tags: ecommerce, e-commerce, store, sales, sell, shop, cart, checkout, downloadable, downloads, paypal, storefront, woo commerce
Requires at least: 4.4
Tested up to: 4.8
Stable tag: 3.1.2
License: GPLv3
License URI: https://www.gnu.org/licenses/gpl-3.0.html
WooCommerce is a powerful, extendable eCommerce plugin that helps you sell anything. Beautifully.
== Description ==
WooCommerce is a free eCommerce plugin that allows you to sell anything, beautifully. Built to integrate seamlessly with WordPress, WooCommerce is the world’s favorite eCommerce solution that gives both store owners and developers complete control.
With endless flexibility and access to hundreds of free and premium WordPress extensions, WooCommerce now powers 30% of all online stores -- more than any other platform.
[youtube https://www.youtube.com/watch?v=1KahlicghaE]
= Sell anything, anywhere =
With WooCommerce, you can sell both physical and digital goods in all shapes and sizes, offer product variations, multiple configurations, and instant downloads to shoppers, and even sell affiliate goods from online marketplaces.
With premium extensions, you can offer bookings, memberships, and recurring subscriptions. Perhaps you’d like to sell monthly subscriptions for physical goods, or offer your members a discount on digital downloads? It’s all possible.
= Ship wherever you like =
Offer free shipping, flat rate shipping, or make real-time calculations. Limit your shipments to specific countries, or open your store up to the world. Shipping is highly configurable, and WooCommerce even supports drop shipping.
= Extensive payment options =
WooCommerce comes bundled with the ability to accept major credit cards, PayPal, BACS (bank transfers), and cash on delivery. Need additional options? More than 140 region-specific gateways integrate with WooCommerce, including popular choices like Stripe, Authorize.Net, and Amazon Payments.
= You control it all -- forever =
WooCommerce gives you complete control of your store, from taxes to stock levels to customer accounts. Add and remove extensions, change your design, and switch settings as you please. It’s all under your control.
One of the biggest risks of using a hosted eCommerce platform is what happens to your store if the provider closes up shop. With WooCommerce, you have complete control, so there’s never any reason to worry. Your data belongs to you -- and it’s kept secure, thanks to regular audits by industry leaders.
= Define your style with Storefront =
[Storefront](https://wordpress.org/themes/storefront/) is a free WordPress theme available to any WooCommerce store. Along with deep WooCommerce integration, Storefront prioritizes speed and uptime while eliminating theme and plugin conflicts during major updates.
Define your style even further by customizing Storefront to your liking or choosing from one of our several [Storefront child themes](https://woocommerce.com/product-category/themes/storefront-child-theme-themes/). It’s all up to you, and all open source.
= Built with developers in mind =
Extendable, adaptable, and open source -- WooCommerce was created with developers in mind. With its strong, robust framework, you can scale your client’s store all the way from basic to high-end (infinity and beyond).
Built with a REST API, WooCommerce can integrate with virtually any service. Your store’s data can be accessed anywhere, anytime, 100% securely. WooCommerce allows developers to easily create, modify, and grow a store that meets their specifications.
No matter the size of the store you want to build, WooCommerce will scale to meet your requirements. With a growing collection of more than 300 extensions, you can enhance each store’s features to meet your client’s unique needs -- or even create your own solution.
If security is a concern, rest easy. WooCommerce is audited by a dedicated team of developers working around the clock to identify and patch any and all discovered bugs.
We also support WooCommerce and all its extensions with comprehensive, easily-accessible documentation. With our docs, you’ll learn how to create the exact site your client needs.
= Extensions galore =
WordPress.org is home to some amazing extensions for WooCommerce, including:
- [Google Analytics](https://wordpress.org/plugins/woocommerce-google-analytics-integration/)
- [Delivery Notes](https://wordpress.org/plugins/woocommerce-delivery-notes/)
- [PDF Invoices and Packing Slips](https://wordpress.org/plugins/woocommerce-pdf-invoices-packing-slips/)
- [Affiliates Integration Light](https://wordpress.org/plugins/affiliates-woocommerce-light/)
- [New Product Badges](https://wordpress.org/plugins/woocommerce-new-product-badge/)
Keen to see them all? Search WordPress.org for ‘WooCommerce’ to dive in.
If you’re looking for something endorsed and maintained by the developers who built WooCommerce, there are a plethora of premium eCommerce extensions, the most popular of which include:
- [WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/)
- [WooCommerce Memberships](https://woocommerce.com/products/woocommerce-memberships/)
- [WooCommerce Bookings](https://woocommerce.com/products/woocommerce-bookings/)
- [Dynamic Pricing](https://woocommerce.com/products/dynamic-pricing/)
- [Table Rate Shipping](https://woocommerce.com/products/table-rate-shipping/)
- [Product CSV Import Suite](https://woocommerce.com/products/product-csv-import-suite/)
And there’s plenty more where they came from. Visit our [extensions page](https://woocommerce.com/product-category/woocommerce-extensions/) to find out everything you’re capable of and all that's possible with premium WooCommerce extensions.
= Join our growing community =
When you download WooCommerce, you join a community of more than a million store owners, developers, and WordPress enthusiasts. We’re one of the fastest-growing open source communities online, and whether you’re a n00b or a Ninja, we’d love to have you!
If you’re interested in contributing to WooCommerce we’ve got more than 350 contributors, and there’s always room for more. Head over to the [WooCommerce GitHub Repository](https://github.com/woocommerce/woocommerce) to find out how you can pitch in.
Want to add a new language to WooCommerce? Swell! You can contribute via [translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/woocommerce).
And, finally, consider joining or spearheading a WooCommerce Meetup locally, more about those [here](https://woocommerce.com/woocommerce/meetups/).
== Installation ==
= Minimum Requirements =
* PHP version 5.2.4 or greater (PHP 5.6 or greater is recommended)
* MySQL version 5.0 or greater (MySQL 5.6 or greater is recommended)
* Some payment gateways require fsockopen support (for IPN access)
* WooCommerce 2.5 requires WordPress 4.1+
* WooCommerce 2.6 requires WordPress 4.4+
Visit the [WooCommerce server requirements documentation](https://docs.woocommerce.com/document/server-requirements/) for a detailed list of server requirements.
= Automatic installation =
Automatic installation is the easiest option as WordPress handles the file transfers itself and you don’t need to leave your web browser. To do an automatic install of WooCommerce, log in to your WordPress dashboard, navigate to the Plugins menu and click Add New.
In the search field type “WooCommerce” and click Search Plugins. Once you’ve found our eCommerce plugin you can view details about it such as the point release, rating and description. Most importantly of course, you can install it by simply clicking “Install Now”.
= Manual installation =
The manual installation method involves downloading our eCommerce plugin and uploading it to your webserver via your favourite FTP application. The WordPress codex contains [instructions on how to do this here](https://codex.wordpress.org/Managing_Plugins#Manual_Plugin_Installation).
= Updating =
Automatic updates should work like a charm; as always though, ensure you backup your site just in case.
If on the off-chance you do encounter issues with the shop/category pages after an update you simply need to flush the permalinks by going to WordPress > Settings > Permalinks and hitting 'save'. That should return things to normal.
= Dummy data =
WooCommerce comes with some dummy data you can use to see how products look; either import dummy_data.xml via the [WordPress importer](https://wordpress.org/plugins/wordpress-importer/) or use our [CSV Import Suite plugin](https://woocommerce.com/products/product-csv-import-suite/) to import dummy_data.csv and dummy_data_variations.csv.
== Frequently Asked Questions ==
= Where can I find WooCommerce documentation and user guides? =
For help setting up and configuring WooCommerce please refer to our [user guide](https://docs.woocommerce.com/documentation/plugins/woocommerce/getting-started/)
For extending or theming WooCommerce, see our [codex](https://docs.woocommerce.com/documentation/plugins/woocommerce/woocommerce-codex/).
= Where can I get support or talk to other users? =
If you get stuck, you can ask for help in the [WooCommerce Plugin Forum](https://wordpress.org/support/plugin/woocommerce).
For help with premium extensions from WooCommerce.com, use [our helpdesk](https://woocommerce.com/my-account/tickets/).
= Will WooCommerce work with my theme? =
Yes; WooCommerce will work with any theme, but may require some styling to make it match nicely. Please see our [codex](https://docs.woocommerce.com/documentation/plugins/woocommerce/woocommerce-codex/) for help. If you're looking for a theme with built in WooCommerce integration we recommend [Storefront](https://woocommerce.com/storefront/).
= Where can I request new features, eCommerce themes and extensions? =
You can vote on and request new features and extensions in our [WooIdeas board](http://ideas.woothemes.com/forums/133476-woocommerce)
= Where can I report bugs or contribute to the project? =
Bugs can be reported either in our support forum or preferably on the [WooCommerce GitHub repository](https://github.com/woocommerce/woocommerce/issues).
= Where can I find the REST API documentation? =
You can find the documentation of our REST API on the [WooCommerce REST API Docs](https://woocommerce.github.io/woocommerce-rest-api-docs/).
= WooCommerce is awesome! Can I contribute? =
Yes you can! Join in on our [GitHub repository](http://github.com/woocommerce/woocommerce/) :)
== Screenshots ==
1. The slick WooCommerce settings panel.
2. WooCommerce products admin.
3. Product data panel.
4. WooCommerce sales reports.
5. A single product page.
6. A product archive (grid).
== Changelog ==
= 3.2.0 - 2017-XX-XX =
* Feature - Coupons can now be applied and removed in admin when editing unpaid orders.
* Feature - Simplified the ability to resend order details to customers with a single "Resend Order Details" action.
* Feature - Added store street address, city and postal code to settings for use by plugins.
* Feature - Wrapping values in quotes now let's you use commas in the product CSV importer.
* Feature - If a fatal error occurs, WooCommerce will catch and log it to be viewed in WC > Status > Logs.
* Feature - Drag and drop sorting on the grouped product field to control display order.
* Feature - Integrated selectWoo; more accessible Select2 (enhanced select boxes) in admin and on the front-end.
* Feature - Enhanced select boxes in the shipping calculator.
* Feature - Enhanced select boxes in layered nav "or" widget.
* Feature - Ajaxified the product category filter on the products screen.
* Feature - `[products]` shortcode can be used in place of other product shortcodes - one shortcode to rule them all.
* Feature - Added option to control maximum depth of product category widget, and cleaned up widget naming.
* Feature - Show sorting options when viewing search results. This defaults to sorting by relevance.
* Feature - Support for the `WC tested up to` plugin header to show which extensions have been tested against updates.
* Feature - Helper - Filters on the subscription management screen, update notifications, and support for shared licenses.
* Tweak - Importer now supports menu_order property, adds filename based titles to imported images, and correctly sets post status of variations.
* Tweak - Made the buyer phone number clickable in the in the order back-end.
* Tweak - Clean up user is_paying_customer after deleting an order.
* Tweak - If stock changes between page load and editing, reject stock changes to avoid incorrect stock changes.
* Tweak - Disable search engines indexing core, dynamic, cart/checkout pages.
* Tweak - Added shortcodes to description output in structured data, and improved variable product data.
* Tweak - Use AJAX when restoring an item in the cart, and removing an item from the mini-cart.
* Tweak - On-boarding: added "next" button to pointers and allowed them to be dismissed.
* Tweak - Display post states for WC pages e.g. shop, checkout etc.
* Tweak - Improved order tracking page display and validation.
* Tweak - Wizard improvements, with store-owner newsletter sign-up.
* Tweak - Improved tax calculations on negative fees by apportioning to all items.
* Tweak - Added logic to install the plugins and themes asynchronously without using wp-cron.
* Tweak - Modify product API returned data by context.
* Tweak - Move js clipboards off of zeroclipboard script.
* Tweak - Remove spam trap field from registration form.
* Tweak - Added screen reader text to quantity input template.
* Fix - Improved error handling in the CSV importer when invalid files are uploaded.
* Fix - Handle full refunds in tax report by date.
* Fix - API - Return empty result when there is no on_sale products.
* Fix - Fixed WC_Emails::wrap_message hooks .
* Fix - Load up gateways on ajax order status transitions so PayPal funds capture when order is completed.
* Fix - Replace wistia videos with youtube.
* Fix - Handle sale dates on the fly in case of missed cron schedule.
* Fix - If sorting by date in the REST API, fallback to ID so searches are consistant.
* Fix - Do not apply custom sorting to product feeds.
* Fix - Make importer columns case-insensitive.
* Dev - Make parse_date_for_wp_query public.
* Dev - API - Creating webhooks uses the current API version rather than the latest API version.
* Dev - Product CRUD search helpers.
* Dev - Refactor shipping rate to include instance IDs, and pass instance IDs through filters.
* Dev - New attribute helper functions.
* Dev - Order note helper functions.
* Dev - Added the "Terms and conditions" page to the api system status report.
* Dev - Made date inputs reusable.
* Dev - Added option for merging when using 'Order Again' via filter `woocommerce_empty_cart_when_order_again`.
* Dev - Added system status tool for re-populating order address search indexes.
* Dev - Added system status tool for clearing webhook logs.
* Dev - Added woocommerce_get_asset_url filter.
* Dev - Show notice when internal meta props are accessed directly.
* Dev - Improve meta data updates so data is only updated when changed.
* Dev - Improved get_filtered_term_product_counts performance.
* Dev - Introduced wc_get_account_orders_actions function.
* Dev - `wc_get_account_formatted_address` can get address by customer ID.
* Dev - Added `woocommerce_get_product_id_by_sku` filter.
* Dev - Refactored cart to use new WC_Cart_Session/WC_Cart_Totals/WC_Cart_Fees/WC_Discounts classes.
* Dev - New `WC_Shortcode_Products` class to handle all product based shortcodes.
* Theming - Display downloads in their own table, universally, using a new template file.
* Theming - Checkout: Order pay template
* Localization - Added cantons of Switzerland.
* Localization - Updated XAF and XOF currency codes.
* Localization - Added rtl support for activation.css.
* Localization - Updated Mexican states to use correct 2 letter codes.
* Localization - Improved many strings by excluding HTML.
* Many smaller fixes and improvements - see GitHub!
[See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce/master/CHANGELOG.txt).
== Upgrade Notice ==
= 3.0 =
3.0 is a major update. Make a full site backup, update your theme and extensions, and [review update best practices](https://docs.woocommerce.com/document/how-to-update-your-site) before upgrading.