woocommerce/plugins/woocommerce-blocks/docs/extensibility
Mike Jolley 7cb46eb092 Prevent duplicate hooks in hook docs (https://github.com/woocommerce/woocommerce-blocks/pull/5472)
* Update wp-hooks-generator

* Update inline hook documentation into consistent format

1. Hook docs for the same hook should be identical
2. Prefix with `Hook: ` so the case of the hook is not changed.
3. Use `@see` instead of `@hooked`. Hooked is not a standard PHP Doc tag.

cc @Aljullu

* Update hook doc script to support duplicate hooks across files

* Remove unused variables in function

Co-authored-by: Thomas Roberts <thomas.roberts@automattic.com>
2022-01-04 14:12:08 +00:00
..
README.md Add hook documentation and build script (https://github.com/woocommerce/woocommerce-blocks/pull/4927) 2021-10-13 10:45:59 +01:00
actions.md Prevent duplicate hooks in hook docs (https://github.com/woocommerce/woocommerce-blocks/pull/5472) 2022-01-04 14:12:08 +00:00
available-endpoints-to-extend.md Add ExtendRestAPI and SlotFills docs (https://github.com/woocommerce/woocommerce-blocks/pull/4208) 2021-06-18 23:32:19 +01:00
available-filters.md Add cart item classname filter (https://github.com/woocommerce/woocommerce-blocks/pull/4992) 2021-11-09 15:15:35 +00:00
available-slot-fills.md Update available-slot-fills.md 2021-10-29 14:45:02 +01:00
checkout-flow-and-events.md Revise checkout payment statuses to avoid data loss on error (https://github.com/woocommerce/woocommerce-blocks/pull/5350) 2021-12-10 16:26:16 +01:00
dom-events.md Make Mini Cart block react to removed_from_cart events (https://github.com/woocommerce/woocommerce-blocks/pull/4947) 2021-10-25 18:05:01 +02:00
extend-rest-api-add-data.md Experimental newsletter subscription checkbox block POC and Store API supporting changes (https://github.com/woocommerce/woocommerce-blocks/pull/4607) 2021-08-30 15:35:20 +01:00
extend-rest-api-formatters.md Document DOM events used in WC Blocks (https://github.com/woocommerce/woocommerce-blocks/pull/4876) 2021-10-06 10:52:53 +02:00
extend-rest-api-new-endpoint.md Add ExtendRestAPI and SlotFills docs (https://github.com/woocommerce/woocommerce-blocks/pull/4208) 2021-06-18 23:32:19 +01:00
extend-rest-api-update-cart.md Add Checkout Package and Checkout i2 Documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4892) 2021-10-12 15:23:52 +01:00
filtering-payment-methods.md Add `register_payment_requirements` documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4994) 2021-11-04 11:45:41 +00:00
filters.md Prevent duplicate hooks in hook docs (https://github.com/woocommerce/woocommerce-blocks/pull/5472) 2022-01-04 14:12:08 +00:00
integration-interface.md Add `IntegrationInterface` documentation (https://github.com/woocommerce/woocommerce-blocks/pull/4394) 2021-06-25 09:13:44 +01:00
payment-method-integration.md Typedefs and cartData for `usePaymentMethodInterface` (https://github.com/woocommerce/woocommerce-blocks/pull/5177) 2021-12-07 13:02:57 +00:00
slot-fills.md Update slot-fills.md 2021-10-29 15:29:37 +01: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 ExtendRestAPI. A list of all available endpoints to extend.
Adding an endpoint to ExtendRestAPI. A step by step process for contributors to expose a new endpoint via ExtendRestApi.
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.