woocommerce/plugins/woocommerce-blocks/docs/extensibility
Mike Jolley eae1d75c86 Store API: Consistent error code and hook naming (https://github.com/woocommerce/woocommerce-blocks/pull/5992)
* Update error codes with `woocommerce_rest_` prefixes.

* Update action and filter hooks with woocommerce_store_api_ prefix

* Update hook docs

* Update error code mismatches

* Update hook name in tests

* update hook name in tests

* phpcs
2022-03-07 13:51:07 +00:00
..
README.md Refactor ExtendRestApi as ExtendSchema and expose `register_endpoint_data` as a public function (https://github.com/woocommerce/woocommerce-blocks/pull/5941) 2022-03-01 10:34:05 +00:00
actions.md Store API: Consistent error code and hook naming (https://github.com/woocommerce/woocommerce-blocks/pull/5992) 2022-03-07 13:51:07 +00:00
available-endpoints-to-extend.md Refactor ExtendRestApi as ExtendSchema and expose `register_endpoint_data` as a public function (https://github.com/woocommerce/woocommerce-blocks/pull/5941) 2022-03-01 10:34:05 +00:00
available-filters.md Update some Cart and Checkout extensibility docs to include the Mini Cart block (https://github.com/woocommerce/woocommerce-blocks/pull/5815) 2022-02-21 16:29:29 +01:00
available-slot-fills.md Refactor ExtendRestApi as ExtendSchema and expose `register_endpoint_data` as a public function (https://github.com/woocommerce/woocommerce-blocks/pull/5941) 2022-03-01 10:34:05 +00:00
checkout-flow-and-events.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
dom-events.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
extend-rest-api-add-data.md StoreAPI: Rename namespace to remove `\Blocks` (https://github.com/woocommerce/woocommerce-blocks/pull/5982) 2022-03-04 13:28:37 +00:00
extend-rest-api-formatters.md Refactor ExtendRestApi as ExtendSchema and expose `register_endpoint_data` as a public function (https://github.com/woocommerce/woocommerce-blocks/pull/5941) 2022-03-01 10:34:05 +00:00
extend-rest-api-new-endpoint.md StoreAPI: Rename namespace to remove `\Blocks` (https://github.com/woocommerce/woocommerce-blocks/pull/5982) 2022-03-04 13:28:37 +00:00
extend-rest-api-update-cart.md StoreAPI: Rename namespace to remove `\Blocks` (https://github.com/woocommerce/woocommerce-blocks/pull/5982) 2022-03-04 13:28:37 +00:00
filtering-payment-methods.md Store API: Consistent error code and hook naming (https://github.com/woocommerce/woocommerce-blocks/pull/5992) 2022-03-07 13:51:07 +00:00
filters.md Store API: Consistent error code and hook naming (https://github.com/woocommerce/woocommerce-blocks/pull/5992) 2022-03-07 13:51:07 +00:00
integration-interface.md Update some Cart and Checkout extensibility docs to include the Mini Cart block (https://github.com/woocommerce/woocommerce-blocks/pull/5815) 2022-02-21 16:29:29 +01:00
payment-method-integration.md Store API: Consistent error code and hook naming (https://github.com/woocommerce/woocommerce-blocks/pull/5992) 2022-03-07 13:51:07 +00:00
slot-fills.md Refactor ExtendRestApi as ExtendSchema and expose `register_endpoint_data` as a public function (https://github.com/woocommerce/woocommerce-blocks/pull/5941) 2022-03-01 10:34:05 +00:00

README.md

Extensibility in WooCommerce Blocks

These documents are all dealing with extensibility in the various WooCommerce Blocks.

Table of Contents

Hooks (actions and filters)

Document Description
Actions Documentation covering action hooks on the server side.
Filters Documentation covering filter hooks on the server side.

REST API

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.
Adding an endpoint to ExtendSchema. A step by step process for contributors to expose a new endpoint via ExtendSchema.
Available Formatters Available Formatters to format data for use in the Store API.

Checkout Payment Methods

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.

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
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.

We're hiring! Come work with us!

🐞 Found a mistake, or have a suggestion? Leave feedback about this document here.