- Imports and dependency extration
- Hooks (actions and filters)
- REST API
- Checkout Payment Methods
- Checkout Block
These documents are all dealing with extensibility in the various WooCommerce Blocks.
The documentation in this section will use window globals in code examples, for example:
const { registerCheckoutFilters } = window.wc.blocksCheckout;
However, if you're using @woocommerce/dependency-extraction-webpack-plugin
for enhanced dependency management you can instead use ES module syntax:
import { registerCheckoutFilters } from '@woocommerce/blocks-checkout';
See https://www.npmjs.com/package/@woocommerce/dependency-extraction-webpack-plugin for more information.
Document | Description |
---|---|
Actions | Documentation covering action hooks on the server side. |
Filters | Documentation covering filter hooks on the server side. |
Document | Description |
---|---|
Exposing your data in the Store API. | Explains how you can add additional data to Store API endpoints. |
Available endpoints to extend with ExtendSchema | A list of all available endpoints to extend. |
Available Formatters | Available Formatters to format data for use in the Store API. |
Updating the cart with the Store API | Update the server-side cart following an action from the front-end. |
Document | Description |
---|---|
Checkout Flow and Events | All about the checkout flow in the checkout block and the various emitted events that can be subscribed to. |
Payment Method Integration | Information about implementing payment methods. |
Filtering Payment Methods | Information about filtering the payment methods available in the Checkout Block. |
In addition to the reference material below, please see the block-checkout
package documentation which is used to extend checkout with Filters, Slot Fills, and Inner Blocks.
Document | Description |
---|---|
How the Checkout Block processes an order | The detailed inner workings of the Checkout Flow. |
IntegrationInterface | The IntegrationInterface class and how to use it to register scripts, styles, and data with WooCommerce Blocks. |
Available Filters | All about the filters that you may use to change values of certain elements of WooCommerce Blocks. |
Slots and Fills | Explains Slot Fills and how to use them to render your own components in Cart and Checkout. |
Available Slot Fills | Available Slots that you can use and their positions in Cart and Checkout. |
DOM Events | A list of DOM Events used by some blocks to communicate between them and with other parts of WooCommerce. |
Filter Registry | The filter registry allows callbacks to be registered to manipulate certain values. |
We're hiring! Come work with us!
🐞 Found a mistake, or have a suggestion? Leave feedback about this document here.