-
Notifications
You must be signed in to change notification settings - Fork 10.8k
Home
Howdy!
Welcome to the WooCommerce Wiki, the traditional home of our developer-centric documentation for WooCommerce. As part of our ongoing commitment to enhancing documentation accessibility and clarity, we are currently transitioning to a refreshed docs folder located directly within the WooCommerce monorepo.
While some articles will remain in this wiki during the transition, our primary aim is to centralize and refine our documentation for a seamless experience for WooCommerce developers.
To assist you further, here are some essential links:
| Resource | Description |
|---|---|
| Developer Documentation | A centralized collection of documentation, tools, and resources for developers working with WooCommerce. |
| Developer Resources | Check out a list of the key resources for Woo developers. |
| Developer Tools | The tools you need for working with WooCommerce. |
| REST API Documentation | Covers our latest REST API and legacy versions v1, v2 and v3. |
| Internal API Documentation | Automagically generated from our source code. |
| End-user Documentation | Docs for users, including documentation for extensions. |
| The Development Blog | Where we post about new features and work we're doing on core. |
| How to contribute | How to contribute to WooCommerce core. |
Spotted a mistake or have a suggestion to improve the wiki? Please create a new issue describing the change you would like to see. Feel free to include any suggested text as a comment.
WooCommerce is an open source commerce platform built for WordPress and lovingly crafted by Automattic and the WooCommerce community 💜. Come and work with us!
Contribution
- Set up development environment
- Our Git Flow
- SCSS and JS minification
- Naming conventions
- CSS SASS coding guidelines and naming conventions
- Critical Flows
- API Critical Flows
- String localisation guidelines
- Translating WooCommerce
- Deprecation in core
- Adding Actions and Filters
- Common Issues
- Writing high-quality testing instructions
Release Notes
- Release Testing Instructions
- 3.6.x notes/FAQ
- 2.6.x to 3.0.0 Developer Migration Notes
- Select2 fields not working in 3.0.x
- Thumbnail Image Regeneration in 3.3+
- Customizing image sizes in 3.3+
REST API and CLI
CRUD & Data Descriptions
- Database Description
- CRUD Objects in 3.0
- Order and Order Line Item Data
- Coupon Data
- Customer Data
- Product Data
- Data Stores
Internal APIs
Theming
- Enabling product gallery features (zoom, swipe, lightbox)
- Template File Guidelines for Devs and Theme Authors
Examples / Guides