woocommerce/readme.txt

229 lines
16 KiB
Plaintext
Raw Normal View History

2016-01-18 11:34:57 +00:00
=== WooCommerce ===
2018-01-30 15:06:39 +00:00
Contributors: automattic, mikejolley, jameskoster, claudiosanches, claudiulodro, kloon, rodrigosprimo, jshreve, coderkevin
Tags: ecommerce, e-commerce, store, sales, sell, shop, cart, checkout, downloadable, downloads, paypal, storefront, woo commerce
Requires at least: 4.7
2018-11-27 18:51:24 +00:00
Tested up to: 5.0
Stable tag: 3.5.0
2012-06-10 19:12:06 +00:00
License: GPLv3
2016-05-27 01:48:49 +00:00
License URI: https://www.gnu.org/licenses/gpl-3.0.html
2012-02-16 16:54:22 +00:00
WooCommerce is a powerful, extendable eCommerce plugin that helps you sell anything. Beautifully.
2011-08-09 15:16:18 +00:00
== Description ==
WooCommerce is a free eCommerce plugin that allows you to sell anything, beautifully. Built to integrate seamlessly with WordPress, WooCommerce is the worlds favorite eCommerce solution that gives both store owners and developers complete control.
2012-02-16 16:54:22 +00:00
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 youd like to sell monthly subscriptions for physical goods, or offer your members a discount on digital downloads? Its all possible.
2012-06-21 13:30:04 +00:00
= 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.
2012-06-21 13:30:04 +00:00
= 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. Its 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 theres never any reason to worry. Your data belongs to you — and its kept secure, thanks to regular audits by industry leaders.
= Define your style with Storefront =
2012-02-18 14:17:07 +00:00
[Storefront](https://woocommerce.com/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.
2014-02-10 11:15:27 +00:00
2016-07-05 22:52:16 +00:00
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/). Its all up to you, and all open source.
2012-06-10 19:12:06 +00:00
= Built with developers in mind =
2014-02-10 11:15:27 +00:00
Extendable, adaptable, and open source — WooCommerce was created with developers in mind. With its strong, robust framework, you can scale your clients store all the way from basic to high-end (infinity and beyond).
2013-03-01 17:17:11 +00:00
Built with a REST API, WooCommerce can integrate with virtually any service. Your stores data can be accessed anywhere, anytime, 100% securely. WooCommerce allows developers to easily create, modify, and grow a store that meets their specifications.
2012-06-10 19:12:06 +00:00
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 stores features to meet your clients unique needs — or even create your own solution.
2014-02-10 11:15:27 +00:00
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.
2014-02-10 11:15:27 +00:00
We also support WooCommerce and all its extensions with comprehensive, easily-accessible documentation. With our docs, youll learn how to create the exact site your client needs.
2014-02-10 11:15:27 +00:00
= Extensions galore =
2015-02-04 16:40:13 +00:00
WordPress.org is home to some amazing extensions for WooCommerce, including:
2015-02-04 16:40:13 +00:00
2016-01-25 15:46:56 +00:00
- [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/)
2014-02-10 11:15:27 +00:00
Keen to see them all? Search WordPress.org for WooCommerce to dive in.
2012-02-18 14:17:07 +00:00
If youre 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:
2016-07-05 22:52:16 +00:00
- [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/)
2016-07-05 22:52:16 +00:00
And theres plenty more where they came from. Visit our [extensions page](https://woocommerce.com/product-category/woocommerce-extensions/) to find out everything youre 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 no matter your skill level we'd love to have you!
If youre interested in contributing to WooCommerce weve got more than 350 contributors, and theres always room for more. Head over to the [WooCommerce GitHub Repository](https://github.com/woocommerce/woocommerce) to find out how you can pitch in.
2015-10-09 10:31:42 +00:00
Want to add a new language to WooCommerce? Swell! You can contribute via [translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/woocommerce).
2016-07-05 22:52:16 +00:00
And, finally, consider joining or spearheading a WooCommerce Meetup locally, more about those [here](https://woocommerce.com/woocommerce/meetups/).
== Installation ==
2011-08-09 15:16:18 +00:00
= Minimum Requirements =
* PHP version 5.2.4 or greater (PHP 7.2 or greater is recommended)
* MySQL version 5.0 or greater (MySQL 5.6 or greater is recommended)
Visit the [WooCommerce server requirements documentation](https://docs.woocommerce.com/document/server-requirements/) for a detailed list of server requirements.
2011-08-09 15:16:18 +00:00
= Automatic installation =
2014-02-10 11:15:27 +00:00
Automatic installation is the easiest option as WordPress handles the file transfers itself and you dont 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.
2011-08-09 15:16:18 +00:00
2015-11-10 11:30:07 +00:00
In the search field type “WooCommerce” and click Search Plugins. Once youve 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”.
2011-08-09 15:16:18 +00:00
= Manual installation =
2011-08-09 15:16:18 +00:00
2016-05-27 01:48:49 +00:00
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).
2011-08-09 15:16:18 +00:00
2014-02-10 11:15:27 +00:00
= Updating =
2012-02-18 14:17:07 +00:00
2013-03-01 17:17:11 +00:00
Automatic updates should work like a charm; as always though, ensure you backup your site just in case.
2012-02-18 14:17:07 +00:00
2013-03-01 17:17:11 +00:00
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.
2012-02-18 14:17:07 +00:00
= Sample data =
2013-01-02 13:52:00 +00:00
2018-01-11 17:07:28 +00:00
WooCommerce comes with some sample data you can use to see how products look; import sample_products.xml via the [WordPress importer](https://wordpress.org/plugins/wordpress-importer/). You can also use the core [CSV importer](https://docs.woocommerce.com/document/product-csv-importer-exporter/) or our [CSV Import Suite plugin](https://woocommerce.com/products/product-csv-import-suite/) to import sample_products.csv.
2013-01-02 13:52:00 +00:00
== Frequently Asked Questions ==
2011-10-03 08:00:10 +00:00
= Where can I find WooCommerce documentation and user guides? =
2016-07-19 10:30:31 +00:00
For help setting up and configuring WooCommerce please refer to our [user guide](https://docs.woocommerce.com/documentation/plugins/woocommerce/getting-started/)
2016-07-19 10:30:31 +00:00
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? =
2015-08-25 06:05:32 +00:00
If you get stuck, you can ask for help in the [WooCommerce Plugin Forum](https://wordpress.org/support/plugin/woocommerce).
2017-08-29 13:53:53 +00:00
For help with premium extensions from WooCommerce.com, use [our helpdesk](https://woocommerce.com/my-account/tickets/).
2012-02-18 10:41:35 +00:00
= Will WooCommerce work with my theme? =
2016-07-19 10:30:31 +00:00
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/).
2012-02-18 10:41:35 +00:00
= Where can I request new features, eCommerce themes and extensions? =
2018-01-25 17:09:34 +00:00
You can vote on and request new features and extensions in our [WooIdeas board](http://ideas.woocommerce.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).
2015-12-17 10:48:46 +00:00
= Where can I find the REST API documentation? =
2015-01-30 15:34:51 +00:00
You can find the documentation of our REST API on the [WooCommerce REST API Docs](https://woocommerce.github.io/woocommerce-rest-api-docs/).
2015-01-30 15:34:51 +00:00
= WooCommerce is awesome! Can I contribute? =
Yes you can! Join in on our [GitHub repository](https://github.com/woocommerce/woocommerce/) :)
== Screenshots ==
2018-04-18 14:02:31 +00:00
1. The WooCommerce settings panel.
2013-01-31 17:30:21 +00:00
2. WooCommerce products admin.
3. Product data panel.
4. WooCommerce sales reports.
5. A single product page.
6. A product archive (grid).
2011-10-03 08:00:10 +00:00
2011-08-09 15:16:18 +00:00
== Changelog ==
2019-01-07 11:27:05 +00:00
= 3.6.0 - 2019-xx-xx =
* Enhancement - Only include order erasure bulk action if erasure is enabled in settings. #22354
2019-01-09 16:52:43 +00:00
* Enhancement - Customer notes containing URLs now automatically converts to clickable links. #21927
2019-01-22 15:21:25 +00:00
* Enhancement - Add increase and decrease stock options to bulk edit form. #22475
2019-01-16 11:35:51 +00:00
* Tweak - Generalize shipping estimate text on cart page. #22467
2019-01-16 15:12:11 +00:00
* Tweak - Include auto draft orders in order list filters. #22380
2019-01-22 14:38:49 +00:00
* Tweak - Only include the network orders widget on the main site dashboard. #22318
2019-01-23 13:27:37 +00:00
* Tweak - Only show available shipping continents when selecting shipping zone region. #22131
2019-01-23 15:25:47 +00:00
* Tweak - Use Shortcode block on default WooCommerce pages. #21817
2019-01-23 21:37:47 +00:00
* Tweak - Show full category hierarchy in product URLs when term IDs are not sequential. #22526
2019-01-07 11:27:05 +00:00
* Dev - Introduce `woocommerce_reviews_title` filter. #22216
2019-01-07 12:51:10 +00:00
* Dev - Added `woocommerce_cheque_process_payment_order_status` filter allowing plugins to change the order status to the Cheque gateway. #21402
2019-01-07 12:53:00 +00:00
* Dev - Add the current coupon object to the `woocommerce_get_shop_coupon_data` filter. #21442
2019-01-07 13:06:23 +00:00
* Dev - New filter `woocommerce_gallery_image_html_attachment_image_params` for manipulating gallery images. #22005
2019-01-07 13:12:37 +00:00
* Dev - New filter `woocommerce_widget_get_current_page_url` for manipulating links in widgets. #21537
2019-01-08 14:24:19 +00:00
* Dev - Move wc_get_template filter to allow plugins to register locations for template files that do not exist in WooCommerce core. #21764
2019-01-08 15:01:28 +00:00
* Dev - Add support for custom classes on global/quantity-input.php. #21553
2019-01-09 11:53:21 +00:00
* Dev - Pass product object to `woocommerce_add_to_cart_redirect` filter where appropriate. #22123
2019-01-09 17:02:05 +00:00
* Dev - Add support for forgetting the cart contents and user session when switching between accounts using the User Switching plugin. #21991
2019-01-10 12:25:49 +00:00
* Dev - Added a consistent form class to the Track Order Form. #21991
2019-01-14 17:01:10 +00:00
* Dev - Add $orderby and $order params to filter `woocommerce_get_catalog_ordering_args`. #22257
2019-01-14 17:02:57 +00:00
* Dev - Add new pre query filter to WC_Product_Data_Store_CPT::search_products(). #22165
2019-01-10 12:28:41 +00:00
* Dev - Added additional parameters to the `woocommerce_variation_option_name` filter. #21153
2019-01-14 17:05:31 +00:00
* Dev - Added new filter `woocommerce_get_min_max_price_meta_query`. #22255
2019-01-16 11:35:51 +00:00
* Dev - Added a filter to WC_REST_CRUD_Controller::get_collection_params method to allow developers to change params in the same way as WP_Rest_Posts_controller::get_collection_params. #21562
2019-01-16 13:02:14 +00:00
* Dev - Add $zone param to woocommerce_shipping_zone_before_methods_table and woocommerce_shipping_zone_after_methods_table actions. #21961
2019-01-16 14:49:05 +00:00
* Dev - Added `woocommerce_geolocation_ajax_get_location_hash` filter. #22350
2019-01-16 15:23:00 +00:00
* Dev - Added `woocommerce_variation_prices_array` filter. #21003
2019-01-16 16:27:38 +00:00
* Dev - Added `wc_emptied_cart` javascript event when cart is emptied. #22469
2019-01-21 15:23:55 +00:00
* Dev - Switched `woocommerce_ordered_again` hook to ref_array. #22425
* Dev - `woocommerce_checkout_before_order_review_heading` action added in checkout form template. #22481
2019-01-21 17:00:08 +00:00
* Dev - Added `woocommerce_variation_header` hook in variations list. #21341
2019-01-16 16:31:42 +00:00
* Dev - Add a filter, woocommerce_current_user_can_edit_customer_meta_fields, to bypass manage_woocommerce when editing customer meta fields. #22277
2019-01-21 15:39:46 +00:00
* Dev - Adds filter on the return value of function 'get_item_tax_rates'. This gives developers the possibility to prevent the mandatory caching of tax rates. #22488
2019-01-21 16:00:05 +00:00
* Dev - Add filters for mail callback in WC_Email::send method. #22394
2019-01-22 12:01:54 +00:00
* Dev - Add an instance method to WC_Admin_Taxonomies. #21884
2019-01-22 13:10:41 +00:00
* Dev - Added `woocommerce_order_is_pending_statuses` filter and `wc_get_is_pending_statuses` function. #22409
2019-01-22 12:05:33 +00:00
* Dev - Filter save_payment_method_checkbox to allow "Save to account" checkbox to be removed from the checkout form. #21859
2019-01-22 11:23:53 +00:00
* Dev - Added triggers to the gallery script to allow 3rd parties to run scripts before and after initialization. #22501
2019-01-22 14:36:03 +00:00
* Dev - Added `woocommerce_add_to_cart_qty_html` filter. #21069
2019-01-22 18:18:36 +00:00
* Dev - Prevent extract from polluting hook arguments in wc_get_template(). #21722
2019-01-22 16:07:02 +00:00
* Dev - Add `woocommerce_pre_remove_cart_item_from_session` hook to allow removal of cart items when the cart is loaded from the session. #22290
2019-01-22 18:29:02 +00:00
* Dev - Add `$attribute` to `woocommerce_product_option_terms` filter. #21648
2019-01-23 15:17:22 +00:00
* Dev - Added error handling and timeout to cart fragment ajax call. #21043
2019-01-23 16:40:25 +00:00
* Dev - Remove unused legacy 'woocommerce_lock_down_admin' option and use filter only instead. #17796
2019-01-23 17:07:52 +00:00
* Dev - Allow custom settings sections in the Shipping tab. #21719
2019-01-22 13:32:49 +00:00
* Fix - Hide ratings on the shop page when reviews are disabled. #22476
2019-01-09 11:28:03 +00:00
* Fix - Fix W3C validation of single product page quantity input. #22333
2019-01-22 13:07:39 +00:00
* Fix - Give product variations a unique guid after creation. #22324
2019-01-22 13:30:14 +00:00
* Fix - Deduct correct refunded amounts in calculated net daily sales export CSV. #22518
2019-01-22 14:48:10 +00:00
* Fix - Country sorting for stores which use a language that uses a lot of accented characters, e.g. Spanish. #22417
2019-01-22 16:13:57 +00:00
* Fix - Customer VAT exempt status now carries through to order when placed via checkout. #22458
2019-01-23 15:13:17 +00:00
* Fix - Handle full refunds for taxes by code report. #21843
* Fix - Option "Used for variations" should show only for variable products when saving attributes. #22524
2019-01-07 12:42:16 +00:00
* Localization - Modify administrative regions of Greece to default to their english ISO 3166-2 names, instead of using the native GR names. #21945
2019-01-16 11:35:51 +00:00
* Localization - Added US Minor Outlying Islands as states to avoid confusion with US. #22468
2019-01-16 11:50:33 +00:00
* Localization - Dutch postcode validation. #22316
2019-01-21 15:23:55 +00:00
* Localization - Made municipality address field optional for Latvia. #22487
* Localization - Added new Venezuelan currency Bs S. #22435
* Localization - Added Danish locale. #22495
[See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce/master/CHANGELOG.txt).
2015-11-11 21:50:25 +00:00
== Upgrade Notice ==
2017-05-31 15:43:36 +00:00
= 3.0 =
2017-05-01 01:16:37 +00:00
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.