woocommerce/docs

WooCommerce Developer Documentation

⚠️ Notice: This documentation is currently a work in progress. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions!

This is your go-to place to find everything you need to know to get started with WooCommerce development, including implementation details for specific parts of the WooCommerce code base.

Getting started

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. It empowers businesses worldwide to sell anything from physical products and digital downloads to subscriptions, content, and even appointments.

Get familiar with WordPress Plugin Development.

Take a moment to familiarize yourself with our Developer Resources.

Once you're ready to move forward, consider one of the following:

• Tools for low code development
• Building your first extension
• How to design a simple extension

Contributions

The WooCommerce ecosystem thrives on community contributions. Whether it's improving documentation, reporting bugs, or contributing code, we greatly appreciate every contribution from our community.

• To contribute to the core WooCommerce project, check out our Contributing guide.
• To contribute to documentation please refer to the documentation style guide.

Support

• To request a new document, correction, or improvement, create an issue.
• For development help, start with the WooCommerce Community Forum, to see if someone else has already asked the same question. You can also pose your question in the #developers channel of our Community Slack. If you're not sure where to ask your question, you can always contact us, and our Happiness Engineers will be glad to point you in the right direction.
• For additional support with customizations, you might consider hiring from WooExperts or Codeable.

Additional Resources

• WooCommerce Official Website
• Woo Marketplace
• All WooCommerce Repositories on GitHub

Other documentation

Some directories contain documentation about their own contents, in the form of README file. The available files are listed below, if you create a new README file please add it to the corresponding list.

Available READMe files for the WooCommerce plugin:

• Root README
• i18n/languages
• includes
• lib
• packages
• src
• src/Admin/RemoteInboxNotifications
• src/Admin/RemoteInboxNotifications/Transformers
• src/Blocks
• src/Internal
• src/Internal/Admin/ProductForm
• tests
• tests/api-core-tests
• tests/e2e
• tests/e2e-pw
• tests/performance
• tests/Tools/CodeHacking

Available READMe files for the WooCommerce Admin plugin:

• Root README
• client/activity-panel
• client/activity-panel/activity-card
• client/activity-panel/activity-header
• client/analytics/report
• client/analytics/settings
• client/dashboard
• client/header
• client/marketing
• client/marketing/components/button
• client/marketing/components/card
• client/marketing/components/product-icon
• client/utils
• client/wp-admin-scripts
• docs
• docs/examples
• docs/examples/extensions
• docs/features
• docs/woocommerce.com

Available READMe files for the WooCommerce Beta Tested plugin:

• Root README
• src/tools
• userscripts