woocommerce/docs
Manish Menaria e28b0aa9ea
Product Collection: Support registering product collection that isn't displayed in Collection Chooser (#52057)
* Filter product collection variations by 'block' scope

This commit updates the product collection feature to only show variations
with the 'block' scope in the collection chooser. To achieve this:

1. Added 'block' to the scope array for various product collection variations
   (best-sellers, featured, hand-picked, new arrivals, on-sale, related,
   top-rated, and upsells).
2. Modified the collection chooser logic to filter variations based on the
   'block' scope.

* Product Collection: Hide collection chooser toolbar for non-block scoped collections

This commit modifies the ToolbarControls component in the Product Collection block to conditionally render the CollectionChooserToolbar. The toolbar is now only displayed for collections with a scope that includes 'block'.

* Add scope property to product collections in E2E tests

This commit adds the 'scope' property to all registered product collections
in the E2E test plugin. The 'scope' is set to ['block'] for each collection.

* Add changefile(s) from automation for the following project(s): woocommerce-blocks

* Rename isShowCollectionChooserToolbar to showCollectionChooserToolbar
for better readability.

* Add documentation and refactor for product collection scope

This commit introduces the following changes:

1. Update documentation to explain the `scope` argument for product collections
2. Refactor Collection Chooser and toolbar controls to handle default scope
3. Remove explicit `scope` from test collections to align with default behavior

* Add E2E tests for Product Collection scope argument

This commit adds E2E tests to verify the behavior of Product Collections
registered with different scopes. It includes:
- Tests for collections with 'inserter' and 'block' scopes
- Verification of visibility in Collection Chooser
- Checks for 'Choose collection' button visibility

* Generate manifest file

* Generate manifest file

* docs: Remove unsupported emojis from product collection documentation

---------

Co-authored-by: github-actions <github-actions@github.com>
2024-10-22 14:02:32 +05:30
..
block-theme-development [Accessibility] Fix misspelling in plugins/woocommerce-blocks/docs (#48562) 2024-08-28 10:00:01 -04:00
building-a-woo-store Fix typo (adding-a-custom-field-to-variable-products.md) (#50331) 2024-09-18 14:15:51 +02:00
cart-and-checkout-blocks Update Payment Integration Docs to Include more examples (#51683) 2024-09-27 14:24:54 +01: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 [Navigation] Remove feature (#51559) 2024-09-28 13:15:27 +12: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 Product Collection: Support registering product collection that isn't displayed in Collection Chooser (#52057) 2024-10-22 14:02:32 +05:30
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-17 18:13:46 +03: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 Card component reference (#48679) 2024-09-23 22:20:56 +08:00
docs-manifest.json Product Collection: Support registering product collection that isn't displayed in Collection Chooser (#52057) 2024-10-22 14:02:32 +05:30

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: