woocommerce/readme.txt

247 lines
19 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
2019-03-15 11:35:07 +00:00
Tested up to: 5.1
2019-03-20 13:13:00 +00:00
Stable tag: 3.5.7
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-04-10 10:40:05 +00:00
= 3.7.0 - 2019-xx-xx =
2019-07-15 14:57:32 +00:00
* Enhancement - Introduce new PHP 5.6 minimum requirement. #23924
* Enhancement - Introduce new WordPress 4.9 minimum requirement.
2019-04-10 10:40:05 +00:00
* Enhancement - Added table ENGINE to system status report for debugging purposes. #23101
2019-04-15 12:37:03 +00:00
* Enhancement - Format empty cart message as information notice. #23152
* Enhancement - Add taxonomy-specific classes to active filters widget. #23122
2019-07-15 14:57:32 +00:00
* Enhancement - Allow emails "Thanks" working to be modified via the email settings. #22927
* Enhancement - Move tax classes from Options to a new `wc_tax_rate_classes` table. #23093
* Enhancement - Make WooCommerce shop roles translatable. #23150
* Enhancement - Prevent the Cart, Checkout and My Account pages from being set to the same pages. #23479
2019-04-15 12:37:03 +00:00
* Fix - Use version_compare for determining max version number. #23092
2019-07-04 19:31:30 +00:00
* Fix - Missing space and closing <strong> tag in WooCommerce.com disconnect message. #24073
2019-07-09 17:27:16 +00:00
* Fix - CSV Importer - Skip rows during update if a SKU column exists, but the value is empty. #23262
2019-07-15 14:57:32 +00:00
* Fix - Allow matching `Any` attributes when calling `find_matching_product_variation`. #23067
* Fix - Switch coupon amount validation based on decimal seperator setting. #23137
* Fix - Show the correct results for shortcodes on static homepages when sorting. #23159
* Fix - Queue AJAX add to cart events to avoid overwriting session data. #23293
* Fix - Subtotals were wrong when changing tax classes via the `woocommerce_product_get_tax_class` filter. #23344
* Fix - Fatal error on plain text order emails where products were deleted. #23754
* Fix - Do not pass the no_shipping argument to PayPal when the order contains shippable items. #23773
* Fix - Product review form now respects the `require_name_email` WordPress core option. #23786
* Fix - Do not cache expired sessions, negative expiry causes errors in some caching modules. #23863
* Fix - WC_Log_Handler_DB logs now uses the same timestamp format as text logs, Y-m-d H:i:s. #23863
* Fix - Display line breaks for customer notes in emails, and order details. #23969
2019-05-10 09:48:09 +00:00
* Tweak - When cleaning up variations due to product type change, force delete them instead of trashing. #23478
* Tweak - Change wording on link to change address to reflect if an address is already present or not. #23532
2019-07-04 19:27:46 +00:00
* Tweak - If variations are missing prices, show notice in product data panel. #23133
2019-07-04 19:30:45 +00:00
* Tweak - Tracks: track status page events. #23190
2019-07-04 19:32:18 +00:00
* Tweak - Updated postcode label to "Postal code" when selected Canada. #23740
2019-07-09 18:47:32 +00:00
* Tweak - Use determine_locale() to properly load custom translation files. #23785
2019-07-09 19:08:22 +00:00
* Tweak - OBW: Switch shipping labels and shipping zones placement. #23781
2019-07-15 14:57:32 +00:00
* Tweak - Show the quantity refunded on customer facing order screens. #23038
* Tweak - Move the settings save functionality from the settings_page_init function to the `wp_loaded` action so it is not save after the settings page renders. #23091
* Tweak - CSV product import now allows true/false values for published field, as well as original 0 (private), -1 (draft), 1 (publish). #23207
* Tweak - Update product attribute sorting tooltip to clarify usage. #23222
* Tweak - Store tax rate percentage in the tax line items. #23268
* Tweak - Remove left and right margin from the logo in emails. #23360
* Tweak - Use the high res version of the WP spinner in the coupon block ui. #23364
* Tweak - Improve user registration validation messages. #23468
* Tweak - Auto generate a new username when a username is blacklisted by WordPress core. #23672
* Tweak - Guest cart session now gets deleted when a user logs in, prevents duplicate cart sessions. #23687
* Tweak - Include the store's base postcode and city when calculating order taxes. #23695
* Tweak - Update the generate username setting description label to reflect how the username is actually generated. #23911
* Tweak - Remove mention of shipping section from the checkout/form-login.php template as shipping is not always a requirement for an order. #23941
* Tweak - Adjust OBW plugin highlight container sizes to avoid overlap. #23997
2019-04-15 13:03:51 +00:00
* Performance - Improve the speed of the admin dashboard by only updating transients once per class. #23011
2019-04-18 10:36:56 +00:00
* Performance - Reduce number of queries needed to populate variations data by priming post caches. #23272
2019-07-15 14:57:32 +00:00
* Performance - Persistant cart improvements, only update the persistent cart if the cart items actually change. Remove `woocommerce_before_cart_item_quantity_zero` action in favor of existing `woocommerce_cart_item_removed` action. #23112
2019-04-15 13:18:26 +00:00
* Localization - Added validation for Italian postcodes. #23269
2019-07-15 14:57:32 +00:00
* Localization - Remove unused tax locale defaults since we now promote auto tax services instead. #23431
* Localization - Define correct address format for Uganda. #23178
* Localization - Hide the postcode and update the state label to "Province" for Mozambique. #23764
* Localization - Setup Wizard: Make postal code optional based on locale data. #23915
* Localization - Add new currency for São Tomé, Príncipe dobra and Mauritanian ouguiya. #23950
* Dev - Add quantity input action hooks (`woocommerce_before_add_to_cart_quantity`, `woocommerce_after_add_to_cart_quantity`). #23166
* Dev - Add $this parameter to email class filters. #23250
* Dev - Add new WC_Abstract_Order::get_coupons() method for returning all coupon line item objects on an order. #23663
2019-07-04 19:29:27 +00:00
* Dev - Added new action 'woocommerce_product_read'. #23181
2019-07-04 19:33:32 +00:00
* Dev - Add filter 'woocommerce_admin_order_buyer_name' to change buyer name in orders list screen. #23741
2019-07-15 14:57:32 +00:00
* Dev - Add actions for when WooCommerce Product Subscription statuses change ( `woocommerce_helper_subscription_activate_success`, `woocommerce_helper_subscription_activate_error`, `woocommerce_helper_subscription_deactivate_success`, `woocommerce_helper_subscription_deactivate_error` ). #23041
* Dev - Extend usage and event tracking (if opted in) to admin order and admin coupon pages. #23189 #23883
* Dev - Add `woocommerce_after_X_object_save` actions, and passed objects to `woocommerce_new_x` and `woocommerce_update_x` actions. #23338
* Dev - Update customer order and lifetime spend totals upon `payment_complete` to trigger `customer.updated` webhooks for paid orders. #23402
* Dev - Preserve the State field's custom css classes when selecting an option from the Country dropdown. #23433
* Dev - Add new filter `woocommerce_before_thankyou` to the checkout/thankyou.php template. #23538
* Dev - Add new `woocommerce_product_related_posts_shuffle` filter to enable/disable related product shuffling, defaults to true. #23562
* Dev - Deprecate `WC_Abstract_Order::get_used_coupons` and replace it with new method `WC_Abstract_Order::get_coupon_codes`. #23689
* Dev - Add new `woocommerce_prices_include_tax` filter in the `wc_prices_include_tax` function. #23697
* Dev - Add new `woocommerce_admin_after_product_gallery_item` filter in `WC_Meta_Box_Product_Images::output` for adding additional markup after product gallery items. #23743
* Dev - Remove unused images `assets/images/klarna-white.png` and `assets/images/square-white.png`. #23748
* Dev - Move Free Shipping method JavaScript from outputting on all shipping setting pages to just the Free Shipping page using the `admin_footer` hook. #23776
* Dev - Prevent PHP fatal error while throwing exceptions in `woocommerce_rest_insert_{post_type}_object` hooks. #23793
* Dev - Add new `woocommerce_enforce_password_strength_meter_on_checkout` filter to allow enforcing password strength meter on checkout. #23811
* Dev - Add new `woocommerce_search_products_post_statuses` filter in `WC_Product_Data_Store_CPT::search_products`. #23838
* Dev - Allow filtering `woocommerce_order_formatted_shipping_address` even when no shipping address is defined. #23859
* Dev - Change the `WC_Product_Data_Store::find_matching_product_variation` query to always respect the orderby. #23881
* Dev - Move all feature plugin features out from the WooCommerce codebase and utilize composer and an autoloader for inclusion, affects WC REST API and WC Blocks. #23957
* Dev - Allow displaying multiple error messages through the registration validation. #23968
* Security - Review and update all template files escaping. #23460
[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.