woocommerce/docs
Jason Kytros 04872e31f2
Merge WooCommerce Brands into core (#50165)
* Move WooCommerce Brands into core

* Fix linting errors in brand-thumbnails.php

* More lint fixes for brand-thumbnails.php

* Fix lint issues in brand-description.php

* Fix lint errors for brand-thumbnails-description

* Lint errors: Fix taxonomy-product_brand

* Lint errors: fix taxonomy-product_brand

* Linting: Try adding a space between ignore command and docblock

* Another try to remove the lowercase file name error

* Another try removing lint error for lowercase files

* Lint errors: Fix brands-a-z.php

* More lint fixes for brands-a-z.php

* More lint fixes for brands-a-z.php

* Lint fixes: brand-description.php

* Another try fixing lint errors for brand-description.php

* Another try fixing lint errors for brand-description.php

* More fixes for brand-description.php

* Fix lint errors for Packages.php

* More fixes for Packages.php

* Linting fixes for Brands.php

* Added docblocks for WC_Widget_Brand_Thumbnails variables

* Add script to fix coding standards for files changed in branch

* Run autofix script for linting

* Lint fixes for class-wc-widget-brand-thumbnails.php

* More lint fixes for: class-wc-widget-brand-thumbnails.php

* More lint fixes for class-wc-widget-brand-thumbnails.php

* Lint fixes for class-wc-widget-brand-nav.php

* lint fixes: ignore docblocks

* Another try to fix missing docblocks

* Another try to fix missing docblocks

* Another try fixing missing docblocks

* Better messages for fix-branch.sh

* Fix lint errors in class-wc-widget-brand-description.php

* Fix linting errors in REST API and functions classes

* Fix linting issues in class-wc-brands.php

* More lint fixes for wc-brands.php

* More lint fixes for wc-brands.php

* Fix lint errors for wc-brands-coupons.php

* Fix lint errors for class-wc-brands-block-templates.php

* Fix linting errors for class-wc-brands-block-template-utils-duplicated.php

* Fix lint errors in class-wc-admin-brands.php

* More fixes in class-wc-admin-brands.php

* More class-wc-admin-brands.php

* More lint fixes for: class-wc-admin-brands.php

* More lint fixes for class-wc-admin-brands.php

* Transfer unit test

* Transfer e2e test

* Added specific versions to templates

* Added changelog

* Another try for HTML templates version

* Fix lint errors in test files

* More lint fixes

* Fix lint warnings

* Added brands to list of expected REST API fields

* More lint warning fixes

* More lint warning fixes

* Updated unit tests to include brands

* Remove whitespace

* Added declare( strict_types = 1); to all PHP files

* Added declare( strict_types = 1) to test file as well

* Fix: There must be exactly one blank line after the file comment

* Temporarily remove Brands e2e tests

* Move Brands blockified templates

* Remove script to fix lint errors in current branch

* Try removing pull-package-deps

* Bring back deps

* Commit pnpm-lock.yaml

* Add debug statements

* More debug statements

* Make regular expression more specific

* Make matches more specific

* Search only for PHP templates

* Bring back whitespace

* Remove unnecessary change

* Update pnpm-lock.yaml

* Change the way Brands files are included

* Include all files

* Prevent Brands assets from being double-enqueued

* Move Brands scripts handling into core

* Revert changes in the template-changes.ts script

* Use strict in_array

* Add scaffolding for Brands test

* Add more scaffolding for Brands tests

* Enhance e2e test by adding steps for creating a Brand

* Move Brands test to Playwright folder

* Added manifest

* Fix lint errors in tests

* Move Brands coupons test into core's coupons tests

* Fix linting error in tests

* Move all Brands initialization within the /Internal/Brands class

* Rename `$merged_packages` to `$merged_plugins`

* Add force disable method back

* Move Brands logic outside core files

* Rename admin styles

* Remove brands logic from core's admin class

* Roll back all changes in admin assets class

* Fix linting errors

* Move REST API logic to Brands main class

* Introduce an option to control whether the Brands package is enabled.
Prevent autoloader from loading classes already loaded by individual Packages.
Fix an issue with Brands admin styles.

* Bring back pnpm-lock

* Add comment

* Split long line into two

* Review default values for remote variant assignment

* Rename global functions and add polyfills for deprecated functions

* Bump versions

* Fix some lint errors

* More lint fixes

* Set woocommerce_remote_variant_assignment for Brands to be enabled for unit tests

* Replace reserved word class with class_name

* Another try to include Brands files in tests

* Remove Brands from REST API tests

* Skip Brands tests while Brands is behind a feature flag

* Lint fixes

* Remove empty line

* Added feature flag.

* Fix widgets form

* Fix lint errors for brand description widget

* Fix lint errors for brand description widget

* Fix lint errors

* Bump version

* Updated tooltips for Brands coupon restrictions to match core's

* Fix lint errors

* More lint fixes

* Add REST API v3 for Brands

---------

Co-authored-by: Walther Lalk <83255+dakota@users.noreply.github.com>
2024-09-18 16:22:10 -07:00
..
block-theme-development [Accessibility] Fix misspelling in plugins/woocommerce-blocks/docs (#48562) 2024-08-28 10:00:01 -04:00
building-a-woo-store Product Collection: Trigger `wc-blocks_viewed_product` JS event (#51156) 2024-09-05 12:52:35 +02:00
cart-and-checkout-blocks Update totals-footer-item.md (#51261) 2024-09-12 13:51:32 +00:00
code-snippets Update totals-footer-item.md (#51261) 2024-09-12 13:51:32 +00:00
contributing Fix markdown typos. (#50282) 2024-08-19 14:59:10 -03:00
contributing-docs fixes and updates (#51144) 2024-09-04 17:11:35 +00:00
data-management Update Woo.com references to WooCommerce.com (#46259) 2024-04-09 09:50:15 +01:00
extensibility-in-blocks Fix markdown typos. (#50282) 2024-08-19 14:59:10 -03:00
extension-development Deprecate unsupported Inbox note banner layout (#51275) 2024-09-13 01:11:11 +00:00
getting-started Update nvm instructions in README.md (#51240) 2024-09-13 14:20:19 -05:00
high-performance-order-storage Update totals-footer-item.md (#51261) 2024-09-12 13:51:32 +00:00
localization-translation Update Woo.com references to WooCommerce.com (#46259) 2024-04-09 09:50:15 +01:00
payments Update payment method integration links for improved a11y and not to point to WC Blocks repo (#47936) 2024-06-03 11:29:11 -07:00
performance fixes and updates (#51144) 2024-09-04 17:11:35 +00:00
product-collection-block Update Markdown lint allowing the same headings if they're not siblings (#51438) 2024-09-18 16:22:08 -07:00
product-editor-development Update totals-footer-item.md (#51261) 2024-09-12 13:51:32 +00:00
quality-and-best-practices Merge WooCommerce Brands into core (#50165) 2024-09-18 16:22:10 -07:00
reporting Update totals-footer-item.md (#51261) 2024-09-12 13:51:32 +00:00
rest-api Fix markdown typos. (#50282) 2024-08-19 14:59:10 -03:00
security Update security-best-practices.md (#46200) 2024-04-29 11:04:59 +02:00
shipping Fix broken links from issue #46336 (#46381) 2024-04-15 14:30:37 +02:00
testing Fix typos (WooCommrece) (#50333) 2024-09-10 08:15:36 -07:00
theme-development Update totals-footer-item.md (#51261) 2024-09-12 13:51:32 +00:00
ux-guidelines-extensions fixes and updates (#51144) 2024-09-04 17:11:35 +00:00
ux-guidelines-payments Fix remaining broken links discovered in SEO orbit (#46398) 2024-04-09 17:10:23 -03:00
ux-guidelines-product-editor Replace copy: List Price to Regular Price (#47658) 2024-05-21 16:28:01 -04:00
ux-guidelines-themes Update Woo.com references to WooCommerce.com (#46259) 2024-04-09 09:50:15 +01:00
wc-cli Update totals-footer-item.md (#51261) 2024-09-12 13:51:32 +00:00
.manifestignore Update .manifestignore (#44091) 2024-01-25 16:01:14 -05:00
.markdownlint.json fix lint rule (#50843) 2024-08-22 14:25:57 +02:00
README.md Update Woo.com references to WooCommerce.com (#46259) 2024-04-09 09:50:15 +01:00
docs-manifest.json Merge WooCommerce Brands into core (#50165) 2024-09-18 16:22:10 -07:00

README.md

post_title
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:

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.

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

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:

Available READMe files for the WooCommerce Admin plugin:

Available READMe files for the WooCommerce Beta Tested plugin: