woocommerce/readme.txt

239 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
Tested up to: 4.9
2018-01-11 15:14:21 +00:00
Stable tag: 3.2.6
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 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.
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](http://github.com/woocommerce/woocommerce/) :)
== Screenshots ==
2013-01-31 17:30:21 +00:00
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).
2011-10-03 08:00:10 +00:00
2011-08-09 15:16:18 +00:00
== Changelog ==
2018-01-05 18:10:17 +00:00
= 3.3.0 - 2018-XX-XX =
2017-11-16 13:16:28 +00:00
* Feature - Improved default appearance in themes which do not support WooCommerce, making the shop page shortcode based.
* Feature - Products shortcodes; improved random sorting, with some caching.
* Feature - Products shortcodes; support for pagination.
* Feature - Added new options to the WordPress Appearance Customizer; control the product grid (rows and columns), and image sizes.
* Feature - Improved how image sizes are defined and calculated. Set an aspect ratio (custom, 1:1, uncropped) and image sizes will be automagically calculated based on widths.
* Feature - Changing image sizes will trigger automatic thumbnail regeneration in the background.
* Feature - Improved how downloads are stored within products, and added new reporting/logging features to track who downloaded what, when.
* Feature - Improved the overall appearance of the backend orders list, and added a new 'preview' button to quickly see order details.
* Feature - New default sample data and placeholders.
2017-11-16 13:16:28 +00:00
* Feature - Added sandbox and live API details to the PayPal standard data, as well as an indication on the checkout to what mode is currently active. PayPal IPN email notifications are also now optional.
* Feature - Introduced product category threshold filter (`woocommerce_product_category_filter_threshold`). AJAX powered select will kick in when you have over 100 categories.
* Feature - Added `add_to_cart_description` method and aria-labels to cart buttons in the loop for accessibility.
* Feature - Ability to search in logs when the database logger is used.
* Performance - Adjusted how permalinks are retrieved and saved to avoid switching locales on each page load.
* Performance - Added cache when loading product variation attributes.
2018-01-11 15:14:21 +00:00
* Fix - Fix wc_notice_count logic.
* Fix - Correct bulk edit price formatting.
* Fix - Ajax add-to-cart button shortcode fix for variations.
* Tweak - Update billing if account form changes.
* Tweak - Remove videos from help sections.
* Tweak - Preserve seconds when saving order date.
* Tweak - Allow quantities less than 1, but not 0, in admin.
* Tweak - Post types with no archives should not show in breadcrumb.
* Tweak - Only load session handler class on frontend not during cron.
2017-11-16 13:16:28 +00:00
* Tweak - Moved the 'Store Notice" option into the customizer.
* Tweak - Checkout Postcode / Zip validation error message was missing Billing / Shipping Identification.
2017-11-16 13:16:28 +00:00
* Tweak - Added Iris color picker validation.
* Tweak - Use scrollIntoView on checkout.
* Tweak - Converted input submit elements to button submit elements across the entire codebase for consistency.
* Tweak - Added `{site_title}` replacement for email footers.
* Tweak - Added delete product confirmation if a product has had sales.
* Tweak - Improved when "incl. VAT" is displayed in cart totals.
* Tweak - Use base text color for links in email templates.
* Tweak - Show theme overrides that are done through the wc_get_template filter in the system status report.
2017-10-27 16:07:06 +00:00
* Tweak - Added nofollow tags in layered nav to prevent duplicate indexed content.
* Tweak - Hide "incl. VAT" when no rates are defined in "single total" display mode.
2017-11-16 13:16:28 +00:00
* Tweak - Added replay protection for refunds.
* Tweak - GeoDB empty file handling.
* Tweak - Let wp_signon handle email to username conversion.
* Tweak - Made email field wider on checkout.
* Tweak - Post entire shipping selection when showing multiple packages.
2018-01-11 15:14:21 +00:00
* Dev - REST API - Orders should be created for users who exist on the site only.
2017-11-16 13:16:28 +00:00
* Dev - REST API - Fixed default value of "dp" on orders and refunds endpoints.
* Dev - Theming - Added theme support variables to declare image sizes used for products.
* Dev - Theming - Added support for single-product-postname.php template files.
* Dev - Added actions before calculations order totals and taxes and is_vat_excempt support.
* Dev - Add filter 'woocommerce_coupon_get_apply_quantity'.
* Dev - Grouped products; added filters to allow custom columns and changes to values.
* Dev - Allow for cloning the WC_Cart object
* Dev - Apply filters to registration-error-email-exists error.
2017-11-16 13:16:28 +00:00
* Dev - Added `woocommerce_cross_sells_order` filter.
* Dev - Add order-details `before` hooks to complement existing hooks.
2017-11-16 13:16:28 +00:00
* Dev - WC_CHUNK_SIZE constant for controlling readfile.
* Dev - Add short circuit to customer bought product function.
2017-11-16 13:16:28 +00:00
* Dev - Added a `wc_caught_exception` method to aid with logging.
* Dev - Added Data stores and CRUD for working with Webhooks.
2017-10-27 16:07:06 +00:00
* Dev - Bumped minimum WP version requirement to 4.5 and removed legacy API files.
* Dev - New actions - `woocommerce_order_details_before_order_table_items`, `woocommerce_order_details_after_order_table_items` and `woocommerce_order_details_before_order_table`
* Dev - Passed `widget_id` to `content-widget-product.php` so actions can be ran conditionally, and added sanitisation to `woocommerce_before_widget_product_list` and `woocommerce_after_widget_product_list`.
* Dev - Improved the `is_internal_meta_key` checks to consider getters and setters.
2017-10-27 17:49:48 +00:00
* Dev - Cleaned up the Order Customer Details template.
2017-11-16 13:16:28 +00:00
* Dev - JavaScript payment_method_selected events on checkout.
2018-01-11 15:14:21 +00:00
* Dev - Add new `$order->get_edit_order_url()` method.
* Dev - Pass through options to zoom, flexslider, and photoswipe.
* Dev - Added actions before and after scheduled sales initiation and completion.
2017-11-16 13:16:28 +00:00
* Localization - Add direction character to currency output.
2018-01-11 15:14:21 +00:00
* Localization - States for Tanzania and Moldova.
[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.