Fixed newly detected broken links (https://github.com/woocommerce/woocommerce-blocks/pull/10537)
* Update check-doc-links.yml * Update check-doc-links.yml * Update check-doc-links.yml * Update check-doc-links.yml * POC: Exclude releases folder from MD link check using “ignorePatterns” * Update check-doc-links.yml to use tcort/markdown-link-check * Update check-doc-links.yml to use existing config * reverted check-doc-links-config.json * fixed broken links * fixed broken links and generated docs * updated docs --------- Co-authored-by: Niels Lange <info@nielslange.de>
This commit is contained in:
Hritik Chaudhary
GitHub
parent
c925c11f25
commit
4199533688
|
|
@ -11,18 +11,23 @@ concurrency:
|
|||
permissions: {}
|
||||
|
||||
jobs:
|
||||
markdown-link-check:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: gaurav-nelson/github-action-markdown-link-check@v1
|
||||
with:
|
||||
use-quiet-mode: 'yes'
|
||||
use-verbose-mode: 'no'
|
||||
config-file: '.github/workflows/check-doc-links-config.json'
|
||||
folder-path: './docs'
|
||||
file-path: './README.md'
|
||||
max-depth: 3
|
||||
base-branch: 'trunk'
|
||||
markdown_link_check:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install markdown-link-check
|
||||
run: npm install -g markdown-link-check
|
||||
|
||||
- name: Run markdown-link-check
|
||||
run: |
|
||||
find ./docs -path ./docs/internal-developers/testing/releases -prune -o -name "*.md" -print0 | xargs -0 -n1 markdown-link-check -c .github/workflows/check-doc-links-config.json
|
||||
|
||||
|
|
|
|||
|
|
@ -603,46 +603,6 @@
|
|||
},
|
||||
"args": 3
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_rest_checkout_process_payment_with_context",
|
||||
"file": "StoreApi/Routes/V1/Checkout.php",
|
||||
"type": "action_reference",
|
||||
"doc": {
|
||||
"description": "Process payment with context.",
|
||||
"long_description": "",
|
||||
"tags": [
|
||||
{
|
||||
"name": "hook",
|
||||
"content": "woocommerce_rest_checkout_process_payment_with_context"
|
||||
},
|
||||
{
|
||||
"name": "throws",
|
||||
"content": "If there is an error taking payment, an \\Exception object can be thrown with an error message.",
|
||||
"types": [
|
||||
"\\Exception"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Holds context for the payment, including order ID and payment method.",
|
||||
"types": [
|
||||
"\\Automattic\\WooCommerce\\StoreApi\\Payments\\PaymentContext"
|
||||
],
|
||||
"variable": "$context"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Result object for the transaction.",
|
||||
"types": [
|
||||
"\\Automattic\\WooCommerce\\StoreApi\\Payments\\PaymentResult"
|
||||
],
|
||||
"variable": "$payment_result"
|
||||
}
|
||||
],
|
||||
"long_description_html": ""
|
||||
},
|
||||
"args": 1
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_shop_loop",
|
||||
"file": "BlockTypes/ClassicTemplate.php",
|
||||
|
|
@ -813,6 +773,40 @@
|
|||
},
|
||||
"args": 2
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_store_api_checkout_order_processed",
|
||||
"file": "StoreApi/Routes/V1/CheckoutOrder.php",
|
||||
"type": "action",
|
||||
"doc": {
|
||||
"description": "Fires before an order is processed by the Checkout Block/Store API.",
|
||||
"long_description": "This hook informs extensions that $order has completed processing and is ready for payment.\n This is similar to existing core hook woocommerce_checkout_order_processed. We're using a new action: - To keep the interface focused (only pass $order, not passing request data). - This also explicitly indicates these orders are from checkout block/StoreAPI.",
|
||||
"tags": [
|
||||
{
|
||||
"name": "since",
|
||||
"content": "7.2.0"
|
||||
},
|
||||
{
|
||||
"name": "see",
|
||||
"content": "",
|
||||
"refers": "https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/3238"
|
||||
},
|
||||
{
|
||||
"name": "example",
|
||||
"content": "docs/examples/checkout-order-processed.md"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Order object.",
|
||||
"types": [
|
||||
"\\WC_Order"
|
||||
],
|
||||
"variable": "$order"
|
||||
}
|
||||
],
|
||||
"long_description_html": "<p>This hook informs extensions that $order has completed processing and is ready for payment.</p> <p>This is similar to existing core hook woocommerce_checkout_order_processed. We're using a new action:</p> <ul> <li>To keep the interface focused (only pass $order, not passing request data).</li> <li>This also explicitly indicates these orders are from checkout block/StoreAPI.</li> </ul>"
|
||||
},
|
||||
"args": 1
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_store_api_checkout_order_processed",
|
||||
"file": "StoreApi/Routes/V1/Checkout.php",
|
||||
|
|
@ -849,7 +843,7 @@
|
|||
},
|
||||
{
|
||||
"name": "woocommerce_store_api_checkout_update_customer_from_request",
|
||||
"file": "StoreApi/Routes/V1/Checkout.php",
|
||||
"file": "StoreApi/Routes/V1/CheckoutOrder.php",
|
||||
"type": "action",
|
||||
"doc": {
|
||||
"description": "Fires when the Checkout Block/Store API updates a customer from the API request data.",
|
||||
|
|
@ -881,24 +875,24 @@
|
|||
"args": 2
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_store_api_checkout_update_order_from_request",
|
||||
"name": "woocommerce_store_api_checkout_update_customer_from_request",
|
||||
"file": "StoreApi/Routes/V1/Checkout.php",
|
||||
"type": "action",
|
||||
"doc": {
|
||||
"description": "Fires when the Checkout Block/Store API updates an order's from the API request data.",
|
||||
"long_description": "This hook gives extensions the chance to update orders based on the data in the request. This can be used in conjunction with the ExtendSchema class to post custom data and then process it.",
|
||||
"description": "Fires when the Checkout Block/Store API updates a customer from the API request data.",
|
||||
"long_description": "",
|
||||
"tags": [
|
||||
{
|
||||
"name": "since",
|
||||
"content": "7.2.0"
|
||||
"content": "8.2.0"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Order object.",
|
||||
"content": "Customer object.",
|
||||
"types": [
|
||||
"\\WC_Order"
|
||||
"\\WC_Customer"
|
||||
],
|
||||
"variable": "$order"
|
||||
"variable": "$customer"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
|
|
@ -909,7 +903,7 @@
|
|||
"variable": "$request"
|
||||
}
|
||||
],
|
||||
"long_description_html": "<p>This hook gives extensions the chance to update orders based on the data in the request. This can be used in conjunction with the ExtendSchema class to post custom data and then process it.</p>"
|
||||
"long_description_html": ""
|
||||
},
|
||||
"args": 2
|
||||
},
|
||||
|
|
|
|||
|
|
@ -120,6 +120,30 @@
|
|||
},
|
||||
"args": 1
|
||||
},
|
||||
{
|
||||
"name": "loop_shop_per_page",
|
||||
"file": "BlockTypes/ProductQuery.php",
|
||||
"type": "filter",
|
||||
"doc": {
|
||||
"description": "",
|
||||
"long_description": "",
|
||||
"tags": [],
|
||||
"long_description_html": ""
|
||||
},
|
||||
"args": 1
|
||||
},
|
||||
{
|
||||
"name": "loop_shop_per_page",
|
||||
"file": "BlockTypes/ProductCollection.php",
|
||||
"type": "filter",
|
||||
"doc": {
|
||||
"description": "",
|
||||
"long_description": "",
|
||||
"tags": [],
|
||||
"long_description_html": ""
|
||||
},
|
||||
"args": 1
|
||||
},
|
||||
{
|
||||
"name": "wc_session_expiration",
|
||||
"file": "StoreApi/Routes/V1/AbstractCartRoute.php",
|
||||
|
|
@ -249,6 +273,39 @@
|
|||
},
|
||||
"args": 4
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_add_to_cart_quantity",
|
||||
"file": "BlockTypes/ProductButton.php",
|
||||
"type": "filter",
|
||||
"doc": {
|
||||
"description": "Filters the change the quantity to add to cart.",
|
||||
"long_description": "",
|
||||
"tags": [
|
||||
{
|
||||
"name": "since",
|
||||
"content": "10.9.0"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "The default quantity.",
|
||||
"types": [
|
||||
"\\Automattic\\WooCommerce\\Blocks\\BlockTypes\\number"
|
||||
],
|
||||
"variable": "$default_quantity"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "The product id.",
|
||||
"types": [
|
||||
"\\Automattic\\WooCommerce\\Blocks\\BlockTypes\\number"
|
||||
],
|
||||
"variable": "$product_id"
|
||||
}
|
||||
],
|
||||
"long_description_html": ""
|
||||
},
|
||||
"args": 2
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_add_to_cart_sold_individually_quantity",
|
||||
"file": "StoreApi/Utilities/CartController.php",
|
||||
|
|
@ -734,6 +791,47 @@
|
|||
},
|
||||
"args": 1
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_cart_item_permalink",
|
||||
"file": "StoreApi/Schemas/V1/CartItemSchema.php",
|
||||
"type": "filter",
|
||||
"doc": {
|
||||
"description": "Filter the product permalink.",
|
||||
"long_description": "This is a hook taken from the legacy cart/mini-cart templates that allows the permalink to be changed for a product. This is specific to the cart endpoint.",
|
||||
"tags": [
|
||||
{
|
||||
"name": "since",
|
||||
"content": "9.9.0"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Product permalink.",
|
||||
"types": [
|
||||
"string"
|
||||
],
|
||||
"variable": "$product_permalink"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Cart item array.",
|
||||
"types": [
|
||||
"array"
|
||||
],
|
||||
"variable": "$cart_item"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Cart item key.",
|
||||
"types": [
|
||||
"string"
|
||||
],
|
||||
"variable": "$cart_item_key"
|
||||
}
|
||||
],
|
||||
"long_description_html": "<p>This is a hook taken from the legacy cart/mini-cart templates that allows the permalink to be changed for a product. This is specific to the cart endpoint.</p>"
|
||||
},
|
||||
"args": 3
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_disable_compatibility_layer",
|
||||
"file": "Templates/AbstractTemplateCompatibility.php",
|
||||
|
|
@ -933,6 +1031,88 @@
|
|||
},
|
||||
"args": 1
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_pay_order_product_has_enough_stock",
|
||||
"file": "StoreApi/Utilities/OrderController.php",
|
||||
"type": "filter",
|
||||
"doc": {
|
||||
"description": "Filters whether or not the product has enough stock.",
|
||||
"long_description": "",
|
||||
"tags": [
|
||||
{
|
||||
"name": "param",
|
||||
"content": "True if has enough stock.",
|
||||
"types": [
|
||||
"boolean"
|
||||
],
|
||||
"variable": ""
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Product.",
|
||||
"types": [
|
||||
"\\WC_Product"
|
||||
],
|
||||
"variable": "$product"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Order.",
|
||||
"types": [
|
||||
"\\WC_Order"
|
||||
],
|
||||
"variable": "$order"
|
||||
},
|
||||
{
|
||||
"name": "since",
|
||||
"content": "9.8.0-dev"
|
||||
}
|
||||
],
|
||||
"long_description_html": ""
|
||||
},
|
||||
"args": 3
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_pay_order_product_in_stock",
|
||||
"file": "StoreApi/Utilities/OrderController.php",
|
||||
"type": "filter",
|
||||
"doc": {
|
||||
"description": "Filters whether or not the product is in stock for this pay for order.",
|
||||
"long_description": "",
|
||||
"tags": [
|
||||
{
|
||||
"name": "param",
|
||||
"content": "True if in stock.",
|
||||
"types": [
|
||||
"boolean"
|
||||
],
|
||||
"variable": ""
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Product.",
|
||||
"types": [
|
||||
"\\WC_Product"
|
||||
],
|
||||
"variable": "$product"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Order.",
|
||||
"types": [
|
||||
"\\WC_Order"
|
||||
],
|
||||
"variable": "$order"
|
||||
},
|
||||
{
|
||||
"name": "since",
|
||||
"content": "9.8.0-dev"
|
||||
}
|
||||
],
|
||||
"long_description_html": ""
|
||||
},
|
||||
"args": 3
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_registration_errors",
|
||||
"file": "StoreApi/Routes/V1/Checkout.php",
|
||||
|
|
@ -1102,6 +1282,39 @@
|
|||
},
|
||||
"args": 1
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_single_product_image_thumbnail_html",
|
||||
"file": "BlockTypes/ProductGalleryThumbnails.php",
|
||||
"type": "filter",
|
||||
"doc": {
|
||||
"description": "Filter the HTML markup for a single product image thumbnail in the gallery.",
|
||||
"long_description": "",
|
||||
"tags": [
|
||||
{
|
||||
"name": "param",
|
||||
"content": "The HTML markup for the thumbnail.",
|
||||
"types": [
|
||||
"string"
|
||||
],
|
||||
"variable": "$thumbnail_html"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "The attachment ID of the thumbnail.",
|
||||
"types": [
|
||||
"int"
|
||||
],
|
||||
"variable": "$attachment_id"
|
||||
},
|
||||
{
|
||||
"name": "since",
|
||||
"content": "7.9.0"
|
||||
}
|
||||
],
|
||||
"long_description_html": ""
|
||||
},
|
||||
"args": 2
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_store_api_add_to_cart_data",
|
||||
"file": "StoreApi/Routes/V1/CartAddItem.php",
|
||||
|
|
@ -1286,66 +1499,6 @@
|
|||
"long_description_html": ""
|
||||
},
|
||||
"args": 1
|
||||
},
|
||||
{
|
||||
"name": "woocommerce_variation_option_name",
|
||||
"file": "StoreApi/Schemas/V1/CartItemSchema.php",
|
||||
"type": "filter",
|
||||
"doc": {
|
||||
"description": "Filters the variation option name.",
|
||||
"long_description": "Filters the variation option name for custom option slugs.",
|
||||
"tags": [
|
||||
{
|
||||
"name": "since",
|
||||
"content": "2.5.0"
|
||||
},
|
||||
{
|
||||
"name": "internal",
|
||||
"content": "Matches filter name in WooCommerce core."
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "The name to display.",
|
||||
"types": [
|
||||
"string"
|
||||
],
|
||||
"variable": "$value"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Unused because this is not a variation taxonomy.",
|
||||
"types": [
|
||||
"null"
|
||||
],
|
||||
"variable": "$unused"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Taxonomy or product attribute name.",
|
||||
"types": [
|
||||
"string"
|
||||
],
|
||||
"variable": "$taxonomy"
|
||||
},
|
||||
{
|
||||
"name": "param",
|
||||
"content": "Product data.",
|
||||
"types": [
|
||||
"\\WC_Product"
|
||||
],
|
||||
"variable": "$product"
|
||||
},
|
||||
{
|
||||
"name": "return",
|
||||
"content": "",
|
||||
"types": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
],
|
||||
"long_description_html": "<p>Filters the variation option name for custom option slugs.</p>"
|
||||
},
|
||||
"args": 4
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -12,11 +12,14 @@ const generateToc = ( hooks ) => {
|
|||
const heading = isDeprecated
|
||||
? `~~${ hookName }~~`
|
||||
: `${ hookName }`;
|
||||
|
||||
let anchor = heading
|
||||
.trim()
|
||||
.toLowerCase()
|
||||
.replace( /\(\)/g, '' )
|
||||
.replace( /\{\$(.*?)->(.*?)}/g, '$1-$2' )
|
||||
.replace( /\{\$(.*?)}/g, '$1' )
|
||||
.replace( /[^\w\- ]+/g, ' ' )
|
||||
.trim()
|
||||
.replace( /\s+/g, '-' )
|
||||
.replace( /\-+$/, '' );
|
||||
if ( usedHeaders.indexOf( anchor ) !== -1 ) {
|
||||
|
|
@ -28,7 +31,6 @@ const generateToc = ( hooks ) => {
|
|||
anchor = anchor + '-' + i;
|
||||
}
|
||||
usedHeaders.push( anchor );
|
||||
|
||||
return `[${ hook.name }](#${ anchor })`;
|
||||
} ),
|
||||
},
|
||||
|
|
|
|||
|
|
@ -152,3 +152,4 @@ The following tutorials from [developer.woocommerce.com](https://developer.wooco
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -36,6 +36,8 @@ Our [JavaScript Build System](javascript-build-system.md) guide offers a detaile
|
|||
|
||||
Last but not least, to get an insight into how CSS is built, refer to the [CSS Build System](css-build-system.md) guide. A firm grasp of this will ensure your CSS files meet the standards and quality expected.
|
||||
|
||||
<!-- FEEDBACK -->
|
||||
|
||||
---
|
||||
|
||||
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
|
||||
|
|
@ -43,3 +45,4 @@ Last but not least, to get an insight into how CSS is built, refer to the [CSS B
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -95,6 +95,7 @@ wc.wcSettings.getSetting( 'key' );
|
|||
|
||||
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
|
||||
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/documentation-guidelines.md)
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/block-assets.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -179,6 +179,7 @@ Notice in the worst case scenario we would have increased selector specificity b
|
|||
|
||||
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
|
||||
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/documentation-guidelines.md)
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/coding-guidelines.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,7 @@ If you're stuck, copy source of an existing story to get started.
|
|||
|
||||
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
|
||||
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/documentation-guidelines.md)
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/components.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -31,6 +31,7 @@ Webpack config is split between several files, some relevant ones for the CSS bu
|
|||
|
||||
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
|
||||
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/documentation-guidelines.md)
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/css-build-system.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -168,3 +168,4 @@ When referencing other documentations, the corresponding document should be link
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/documentation-guidelines.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -62,6 +62,7 @@ By using these packages, you can make your code more modular and easier to maint
|
|||
|
||||
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
|
||||
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/documentation-guidelines.md)
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/e2e-guidelines.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -197,3 +197,4 @@ This file is inspired by the great work of @JustinyAhin and @gziolo in <https://
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/folder-structure.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -151,3 +151,4 @@ To find out more about how to run automated JavaScript tests, check out the docu
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/getting-started.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -84,3 +84,4 @@ Webpack config is split between several files:
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/javascript-build-system.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -118,3 +118,4 @@ When preparing for a new version of WordPress, it's a good practice to search fo
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/javascript-testing.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -53,3 +53,4 @@ If you're stuck, copy source of an existing story to get started.
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/storybook-and-components.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -89,3 +89,4 @@ WooCommerce Blocks avoids using legacy unprefixed classes as much as possible. H
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/designers/theming/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -87,3 +87,4 @@ By default, it uses a combination of black and white borders and shadows so it h
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/designers/theming/cart-and-checkout.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -97,3 +97,4 @@ For example, given that `wc-block-error` changed to `wc-block-components-error`
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/designers/theming/class-names-update-280.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -26,3 +26,4 @@ In [WooCommerce Blocks 3.3.0](https://developer.woocommerce.com/2020/09/02/wooco
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/designers/theming/class-names-update-330.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -17,3 +17,4 @@ In [WooCommerce Blocks 3.4.0](https://developer.woocommerce.com/2020/09/15/wooco
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/designers/theming/class-names-update-340.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -20,3 +20,4 @@ In [WooCommerce Blocks 4.6.0](https://developer.woocommerce.com/2021/03/02/wooco
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/designers/theming/class-names-update-460.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -37,3 +37,4 @@ Notice the code snippet above uses a CSS custom property, so the default color m
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/designers/theming/filter-blocks.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -52,3 +52,4 @@ _All Products_ block was updated so prices follow the same layout as the other p
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/designers/theming/product-grid-270.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@
|
|||
- [Examples](#examples)
|
||||
- [Passing a value from the client through to server side payment processing](#passing-a-value-from-the-client-through-to-server-side-payment-processing)
|
||||
|
||||
This document gives an overview of some of the major architectural components/APIs for the checkout block. If you haven't already, you may also want to read about the [Checkout Flow and Events](../../extensibility/checkout-flow-and-events.md).
|
||||
This document gives an overview of some of the major architectural components/APIs for the checkout block. If you haven't already, you may also want to read about the [Checkout Flow and Events](checkout-flow-and-events.md).
|
||||
|
||||
## Data Stores
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
- [`ShippingProvider` Exposed Statuses](#shippingprovider-exposed-statuses)
|
||||
- [Payment Method Data Store Status](#payment-method-data-store-status)
|
||||
- [Emitting Events](#emitting-events)
|
||||
- [`onCheckoutValidation`](#onCheckoutValidation)
|
||||
- [`onCheckoutValidation`](#oncheckoutvalidation)
|
||||
- [`onPaymentProcessing`](#onpaymentprocessing)
|
||||
- [Success](#success)
|
||||
- [Fail](#fail)
|
||||
|
|
@ -52,7 +52,7 @@ The following statuses exist in the Checkout.
|
|||
|
||||
#### Checkout Data Store Status
|
||||
|
||||
There are various statuses that are exposed on the Checkout data store via selectors. All the selectors are detailed below and in the [Checkout API docs](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/trunk/docs/block-client-apis/checkout/checkout-api.md).
|
||||
There are various statuses that are exposed on the Checkout data store via selectors. All the selectors are detailed below and in the [Checkout API docs](https://github.com/woocommerce/woocommerce-blocks/blob/trunk/docs/internal-developers/block-client-apis/checkout/checkout-api.md).
|
||||
|
||||
You can use them in your component like so
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@
|
|||
- [Experimental flag](#experimental-flag)
|
||||
- [Features behind flags](#features-behind-flags)
|
||||
- [Feature plugin flag](#feature-plugin-flag-1)
|
||||
- [Experimental plugin flag](#experimental-plugin-flag)
|
||||
- [Processes and commands that use a flag](#processes-and-commands-that-use-a-flag)
|
||||
- [Usages of `__experimental` prefix](#usages-of-__experimental-prefix)
|
||||
- [PHP filters and actions](#php-filters-and-actions)
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ Go to: [https://github.com/woocommerce/woocommerce-gateway-stripe/blob/8ffd22aff
|
|||
|
||||
### Interaction with unusable payment methods
|
||||
|
||||
- Install and activate [WooCommerce Bookings](https://github.com/woocommerce/woocommerce-bookings). Add a bookable product, ensure to add a cost to it on the edit product page, then:
|
||||
- Install and activate [WooCommerce Bookings](https://woocommerce.com/products/woocommerce-bookings/). Add a bookable product, ensure to add a cost to it on the edit product page, then:
|
||||
- Add a _normal_ (i.e. Beanie, Hoodie etc.) product to the cart and ensure you can check out successfully.
|
||||
- Then add a bookable product, ensure you can check out successfully.
|
||||
|
||||
|
|
|
|||
|
|
@ -56,3 +56,4 @@ In addition to the reference material below, [please see the `block-checkout` pa
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -367,3 +367,4 @@ The error will also be shown in your console.
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/checkout-block/available-filters.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -101,3 +101,4 @@ Checkout:
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/checkout-block/available-slot-fills.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -50,3 +50,4 @@ _Example usage in WC Blocks:_ Cart and Mini-Cart blocks (via the `useStoreCart()
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/checkout-block/dom-events.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -145,3 +145,4 @@ The `checkPaymentMethodsCanPay()` [function](https://github.com/woocommerce/wooc
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/checkout-block/how-checkout-processes-an-order.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -213,3 +213,4 @@ The value returned here is a plain old JavaScript object, keyed by the keys of t
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/checkout-block/integration-interface.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -72,3 +72,4 @@ For this to work, your script must be enqueued after Cart and Checkout. You can
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/checkout-block/slot-fills.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@ To see the Checkout Flow and Events please consult the following document:
|
|||
|
||||
[Checkout Flow and Events](../../../../docs/internal-developers/block-client-apis/checkout/checkout-flow-and-events.md)
|
||||
|
||||
<!-- FEEDBACK -->
|
||||
|
||||
---
|
||||
|
||||
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
|
||||
|
|
@ -11,3 +13,4 @@ To see the Checkout Flow and Events please consult the following document:
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/checkout-payment-methods/checkout-flow-and-events.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -174,3 +174,4 @@ If you've added your payment method correctly with the correct `supports` values
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/checkout-payment-methods/filtering-payment-methods.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -265,3 +265,4 @@ As an example, you can see how the Stripe extension adds it's integration in thi
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/checkout-payment-methods/payment-method-integration.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -16,3 +16,4 @@
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/data-store/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -410,3 +410,4 @@ const isShippingRateBeingSelected = store.isShippingRateBeingSelected();
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/data-store/cart.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -167,3 +167,4 @@ This is true when the total is being re-calculated for the order. There are nume
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/data-store/checkout.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@
|
|||
- [getSavedPaymentMethods](#getsavedpaymentmethods)
|
||||
- [getActiveSavedPaymentMethods](#getactivesavedpaymentmethods)
|
||||
- [getShouldSavePaymentMethod](#getshouldsavepaymentmethod)
|
||||
- [getCurrentStatus](#getcurrentstatus)
|
||||
- [getCurrentStatus](#deprecated-getcurrentstatus)
|
||||
- [paymentMethodsInitialized](#paymentmethodsinitialized)
|
||||
- [expressPaymentMethodsInitialized](#expresspaymentmethodsinitialized)
|
||||
|
||||
|
|
@ -478,3 +478,4 @@ const expressPaymentMethodsInitialized =
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/data-store/payment.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -206,3 +206,4 @@ showAllValidationErrors();
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/data-store/validation.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -6,46 +6,46 @@
|
|||
|
||||
## Table of Contents
|
||||
|
||||
- [deprecated_function_run](#deprecated_function_run)
|
||||
- [woocommerce_add_to_cart](#woocommerce_add_to_cart)
|
||||
- [woocommerce_after_main_content](#woocommerce_after_main_content)
|
||||
- [woocommerce_after_shop_loop](#woocommerce_after_shop_loop)
|
||||
- [woocommerce_applied_coupon](#woocommerce_applied_coupon)
|
||||
- [woocommerce_archive_description](#woocommerce_archive_description)
|
||||
- [woocommerce_before_main_content](#woocommerce_before_main_content)
|
||||
- [woocommerce_before_shop_loop](#woocommerce_before_shop_loop)
|
||||
- [woocommerce_blocks_cart_enqueue_data](#woocommerce_blocks_cart_enqueue_data)
|
||||
- [woocommerce_blocks_checkout_enqueue_data](#woocommerce_blocks_checkout_enqueue_data)
|
||||
- [woocommerce_blocks_enqueue_cart_block_scripts_after](#woocommerce_blocks_enqueue_cart_block_scripts_after)
|
||||
- [woocommerce_blocks_enqueue_cart_block_scripts_before](#woocommerce_blocks_enqueue_cart_block_scripts_before)
|
||||
- [woocommerce_blocks_enqueue_checkout_block_scripts_after](#woocommerce_blocks_enqueue_checkout_block_scripts_after)
|
||||
- [woocommerce_blocks_enqueue_checkout_block_scripts_before](#woocommerce_blocks_enqueue_checkout_block_scripts_before)
|
||||
- [woocommerce_blocks_loaded](#woocommerce_blocks_loaded)
|
||||
- [woocommerce*blocks*{$this->registry_identifier}\_registration](#woocommerce_blocks_-this--registry_identifier-_registration)
|
||||
- [woocommerce_check_cart_items](#-woocommerce_check_cart_items)
|
||||
- [woocommerce_created_customer](#woocommerce_created_customer)
|
||||
- [woocommerce_no_products_found](#woocommerce_no_products_found)
|
||||
- [woocommerce_register_post](#woocommerce_register_post)
|
||||
- [woocommerce_rest_checkout_process_payment_with_context](#woocommerce_rest_checkout_process_payment_with_context)
|
||||
- [woocommerce_shop_loop](#woocommerce_shop_loop)
|
||||
- [woocommerce_store_api_cart_errors](#woocommerce_store_api_cart_errors)
|
||||
- [woocommerce_store_api_cart_select_shipping_rate](#woocommerce_store_api_cart_select_shipping_rate)
|
||||
- [woocommerce_store_api_cart_update_customer_from_request](#woocommerce_store_api_cart_update_customer_from_request)
|
||||
- [woocommerce_store_api_cart_update_order_from_request](#woocommerce_store_api_cart_update_order_from_request)
|
||||
- [woocommerce_store_api_checkout_order_processed](#woocommerce_store_api_checkout_order_processed)
|
||||
- [woocommerce_store_api_checkout_update_customer_from_request](#woocommerce_store_api_checkout_update_customer_from_request)
|
||||
- [woocommerce_store_api_checkout_update_order_from_request](#woocommerce_store_api_checkout_update_order_from_request)
|
||||
- [woocommerce_store_api_checkout_update_order_meta](#woocommerce_store_api_checkout_update_order_meta)
|
||||
- [woocommerce_store_api_rate_limit_exceeded](#woocommerce_store_api_rate_limit_exceeded)
|
||||
- [woocommerce_store_api_validate_add_to_cart](#woocommerce_store_api_validate_add_to_cart)
|
||||
- [woocommerce_store_api_validate_cart_item](#woocommerce_store_api_validate_cart_item)
|
||||
- [woocommerce\_{$product->get_type()}\_add_to_cart](#woocommerce_-product--get_type-_add_to_cart)
|
||||
- [{$hook}](#-hook)
|
||||
|
||||
- [deprecated_function_run](#deprecated_function_run)
|
||||
- [woocommerce_add_to_cart](#woocommerce_add_to_cart)
|
||||
- [woocommerce_after_main_content](#woocommerce_after_main_content)
|
||||
- [woocommerce_after_shop_loop](#woocommerce_after_shop_loop)
|
||||
- [woocommerce_applied_coupon](#woocommerce_applied_coupon)
|
||||
- [woocommerce_archive_description](#woocommerce_archive_description)
|
||||
- [woocommerce_before_main_content](#woocommerce_before_main_content)
|
||||
- [woocommerce_before_shop_loop](#woocommerce_before_shop_loop)
|
||||
- [woocommerce_blocks_cart_enqueue_data](#woocommerce_blocks_cart_enqueue_data)
|
||||
- [woocommerce_blocks_checkout_enqueue_data](#woocommerce_blocks_checkout_enqueue_data)
|
||||
- [woocommerce_blocks_enqueue_cart_block_scripts_after](#woocommerce_blocks_enqueue_cart_block_scripts_after)
|
||||
- [woocommerce_blocks_enqueue_cart_block_scripts_before](#woocommerce_blocks_enqueue_cart_block_scripts_before)
|
||||
- [woocommerce_blocks_enqueue_checkout_block_scripts_after](#woocommerce_blocks_enqueue_checkout_block_scripts_after)
|
||||
- [woocommerce_blocks_enqueue_checkout_block_scripts_before](#woocommerce_blocks_enqueue_checkout_block_scripts_before)
|
||||
- [woocommerce_blocks_loaded](#woocommerce_blocks_loaded)
|
||||
- [woocommerce_blocks_{$this->registry_identifier}_registration](#woocommerce_blocks_this-registry_identifier_registration)
|
||||
- [woocommerce_check_cart_items](#woocommerce_check_cart_items)
|
||||
- [woocommerce_created_customer](#woocommerce_created_customer)
|
||||
- [woocommerce_no_products_found](#woocommerce_no_products_found)
|
||||
- [woocommerce_register_post](#woocommerce_register_post)
|
||||
- [woocommerce_shop_loop](#woocommerce_shop_loop)
|
||||
- [woocommerce_store_api_cart_errors](#woocommerce_store_api_cart_errors)
|
||||
- [woocommerce_store_api_cart_select_shipping_rate](#woocommerce_store_api_cart_select_shipping_rate)
|
||||
- [woocommerce_store_api_cart_update_customer_from_request](#woocommerce_store_api_cart_update_customer_from_request)
|
||||
- [woocommerce_store_api_cart_update_order_from_request](#woocommerce_store_api_cart_update_order_from_request)
|
||||
- [woocommerce_store_api_checkout_order_processed](#woocommerce_store_api_checkout_order_processed)
|
||||
- [woocommerce_store_api_checkout_update_customer_from_request](#woocommerce_store_api_checkout_update_customer_from_request)
|
||||
- [woocommerce_store_api_checkout_update_order_meta](#woocommerce_store_api_checkout_update_order_meta)
|
||||
- [woocommerce_store_api_rate_limit_exceeded](#woocommerce_store_api_rate_limit_exceeded)
|
||||
- [woocommerce_store_api_validate_add_to_cart](#woocommerce_store_api_validate_add_to_cart)
|
||||
- [woocommerce_store_api_validate_cart_item](#woocommerce_store_api_validate_cart_item)
|
||||
- [woocommerce_{$product->get_type()}_add_to_cart](#woocommerce_product-get_type_add_to_cart)
|
||||
- [{$hook}](#hook)
|
||||
|
||||
---
|
||||
|
||||
## deprecated_function_run
|
||||
|
||||
|
||||
Fires when a deprecated function is called.
|
||||
|
||||
```php
|
||||
|
|
@ -54,18 +54,21 @@ do_action( 'deprecated_function_run' )
|
|||
|
||||
### Source
|
||||
|
||||
- [Domain/Bootstrap.php](../../../../src/Domain/Bootstrap.php)
|
||||
|
||||
- [Domain/Bootstrap.php](../../../../src/Domain/Bootstrap.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_add_to_cart
|
||||
|
||||
|
||||
Fires when an item is added to the cart.
|
||||
|
||||
```php
|
||||
do_action( 'woocommerce_add_to_cart', string $cart_id, integer $product_id, integer $request_quantity, integer $variation_id, array $variation, array $cart_item_data )
|
||||
```
|
||||
|
||||
|
||||
**Note: Matches action name in WooCommerce core.**
|
||||
|
||||
### Description
|
||||
|
|
@ -74,23 +77,25 @@ do_action( 'woocommerce_add_to_cart', string $cart_id, integer $product_id, inte
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| ----------------- | ------- | ---------------------------------------------- |
|
||||
| $cart_id | string | ID of the item in the cart. |
|
||||
| $product_id | integer | ID of the product added to the cart. |
|
||||
| $request_quantity | integer | Quantity of the item added to the cart. |
|
||||
| $variation_id | integer | Variation ID of the product added to the cart. |
|
||||
| $variation | array | Array of variation data. |
|
||||
| $cart_item_data | array | Array of other cart item data. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $cart_id | string | ID of the item in the cart. |
|
||||
| $product_id | integer | ID of the product added to the cart. |
|
||||
| $request_quantity | integer | Quantity of the item added to the cart. |
|
||||
| $variation_id | integer | Variation ID of the product added to the cart. |
|
||||
| $variation | array | Array of variation data. |
|
||||
| $cart_item_data | array | Array of other cart item data. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_after_main_content
|
||||
|
||||
|
||||
Hook: woocommerce_after_main_content
|
||||
|
||||
```php
|
||||
|
|
@ -103,17 +108,20 @@ do_action( 'woocommerce_after_main_content' )
|
|||
|
||||
### See
|
||||
|
||||
- woocommerce_output_content_wrapper_end() - Outputs closing DIV for the content (priority 10)
|
||||
|
||||
- woocommerce_output_content_wrapper_end() - Outputs closing DIV for the content (priority 10)
|
||||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_after_shop_loop
|
||||
|
||||
|
||||
Hook: woocommerce_after_shop_loop.
|
||||
|
||||
```php
|
||||
|
|
@ -122,38 +130,44 @@ do_action( 'woocommerce_after_shop_loop' )
|
|||
|
||||
### See
|
||||
|
||||
- woocommerce_pagination() - Renders pagination (priority 10)
|
||||
|
||||
- woocommerce_pagination() - Renders pagination (priority 10)
|
||||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_applied_coupon
|
||||
|
||||
|
||||
Fires after a coupon has been applied to the cart.
|
||||
|
||||
```php
|
||||
do_action( 'woocommerce_applied_coupon', string $coupon_code )
|
||||
```
|
||||
|
||||
|
||||
**Note: Matches action name in WooCommerce core.**
|
||||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| ------------ | ------ | --------------------------------- |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $coupon_code | string | The coupon code that was applied. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_archive_description
|
||||
|
||||
|
||||
Hook: woocommerce_archive_description.
|
||||
|
||||
```php
|
||||
|
|
@ -162,17 +176,20 @@ do_action( 'woocommerce_archive_description' )
|
|||
|
||||
### See
|
||||
|
||||
- woocommerce_taxonomy_archive_description() - Renders the taxonomy archive description (priority 10)
|
||||
- woocommerce_product_archive_description() - Renders the product archive description (priority 10)
|
||||
|
||||
- woocommerce_taxonomy_archive_description() - Renders the taxonomy archive description (priority 10)
|
||||
- woocommerce_product_archive_description() - Renders the product archive description (priority 10)
|
||||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_before_main_content
|
||||
|
||||
|
||||
Hook: woocommerce_before_main_content
|
||||
|
||||
```php
|
||||
|
|
@ -185,19 +202,22 @@ do_action( 'woocommerce_before_main_content' )
|
|||
|
||||
### See
|
||||
|
||||
- woocommerce_output_content_wrapper() - Outputs opening DIV for the content (priority 10)
|
||||
- woocommerce_breadcrumb() - Outputs breadcrumb trail to the current product (priority 20)
|
||||
- WC_Structured_Data::generate_website_data() - Outputs schema markup (priority 30)
|
||||
|
||||
- woocommerce_output_content_wrapper() - Outputs opening DIV for the content (priority 10)
|
||||
- woocommerce_breadcrumb() - Outputs breadcrumb trail to the current product (priority 20)
|
||||
- WC_Structured_Data::generate_website_data() - Outputs schema markup (priority 30)
|
||||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_before_shop_loop
|
||||
|
||||
|
||||
Hook: woocommerce_before_shop_loop.
|
||||
|
||||
```php
|
||||
|
|
@ -206,18 +226,21 @@ do_action( 'woocommerce_before_shop_loop' )
|
|||
|
||||
### See
|
||||
|
||||
- woocommerce_output_all_notices() - Render error notices (priority 10)
|
||||
- woocommerce_result_count() - Show number of results found (priority 20)
|
||||
- woocommerce_catalog_ordering() - Show form to control sort order (priority 30)
|
||||
|
||||
- woocommerce_output_all_notices() - Render error notices (priority 10)
|
||||
- woocommerce_result_count() - Show number of results found (priority 20)
|
||||
- woocommerce_catalog_ordering() - Show form to control sort order (priority 30)
|
||||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_blocks_cart_enqueue_data
|
||||
|
||||
|
||||
Fires after cart block data is registered.
|
||||
|
||||
```php
|
||||
|
|
@ -226,13 +249,15 @@ do_action( 'woocommerce_blocks_cart_enqueue_data' )
|
|||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/MiniCart.php](../../../../src/BlockTypes/MiniCart.php)
|
||||
- [BlockTypes/Cart.php](../../../../src/BlockTypes/Cart.php)
|
||||
|
||||
- [BlockTypes/MiniCart.php](../../../../src/BlockTypes/MiniCart.php)
|
||||
- [BlockTypes/Cart.php](../../../../src/BlockTypes/Cart.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_blocks_checkout_enqueue_data
|
||||
|
||||
|
||||
Fires after checkout block data is registered.
|
||||
|
||||
```php
|
||||
|
|
@ -241,12 +266,14 @@ do_action( 'woocommerce_blocks_checkout_enqueue_data' )
|
|||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/Checkout.php](../../../../src/BlockTypes/Checkout.php)
|
||||
|
||||
- [BlockTypes/Checkout.php](../../../../src/BlockTypes/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_blocks_enqueue_cart_block_scripts_after
|
||||
|
||||
|
||||
Fires after cart block scripts are enqueued.
|
||||
|
||||
```php
|
||||
|
|
@ -255,12 +282,14 @@ do_action( 'woocommerce_blocks_enqueue_cart_block_scripts_after' )
|
|||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/Cart.php](../../../../src/BlockTypes/Cart.php)
|
||||
|
||||
- [BlockTypes/Cart.php](../../../../src/BlockTypes/Cart.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_blocks_enqueue_cart_block_scripts_before
|
||||
|
||||
|
||||
Fires before cart block scripts are enqueued.
|
||||
|
||||
```php
|
||||
|
|
@ -269,12 +298,14 @@ do_action( 'woocommerce_blocks_enqueue_cart_block_scripts_before' )
|
|||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/Cart.php](../../../../src/BlockTypes/Cart.php)
|
||||
|
||||
- [BlockTypes/Cart.php](../../../../src/BlockTypes/Cart.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_blocks_enqueue_checkout_block_scripts_after
|
||||
|
||||
|
||||
Fires after checkout block scripts are enqueued.
|
||||
|
||||
```php
|
||||
|
|
@ -283,12 +314,14 @@ do_action( 'woocommerce_blocks_enqueue_checkout_block_scripts_after' )
|
|||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/Checkout.php](../../../../src/BlockTypes/Checkout.php)
|
||||
|
||||
- [BlockTypes/Checkout.php](../../../../src/BlockTypes/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_blocks_enqueue_checkout_block_scripts_before
|
||||
|
||||
|
||||
Fires before checkout block scripts are enqueued.
|
||||
|
||||
```php
|
||||
|
|
@ -297,12 +330,14 @@ do_action( 'woocommerce_blocks_enqueue_checkout_block_scripts_before' )
|
|||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/Checkout.php](../../../../src/BlockTypes/Checkout.php)
|
||||
|
||||
- [BlockTypes/Checkout.php](../../../../src/BlockTypes/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_blocks_loaded
|
||||
|
||||
|
||||
Fires when the woocommerce blocks are loaded and ready to use.
|
||||
|
||||
```php
|
||||
|
|
@ -315,11 +350,13 @@ do_action( 'woocommerce_blocks_loaded' )
|
|||
|
||||
### Source
|
||||
|
||||
- [Domain/Bootstrap.php](../../../../src/Domain/Bootstrap.php)
|
||||
|
||||
- [Domain/Bootstrap.php](../../../../src/Domain/Bootstrap.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce*blocks*{$this->registry_identifier}\_registration
|
||||
## woocommerce_blocks_{$this->registry_identifier}_registration
|
||||
|
||||
|
||||
Fires when the IntegrationRegistry is initialized.
|
||||
|
||||
|
|
@ -333,26 +370,30 @@ do_action( 'woocommerce_blocks_{$this->registry_identifier}_registration', \Auto
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| -------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| $this | \Automattic\WooCommerce\Blocks\Integrations\IntegrationRegistry | Instance of the IntegrationRegistry class which exposes the IntegrationRegistry::register() method. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $this | \Automattic\WooCommerce\Blocks\Integrations\IntegrationRegistry | Instance of the IntegrationRegistry class which exposes the IntegrationRegistry::register() method. |
|
||||
|
||||
### Source
|
||||
|
||||
- [Integrations/IntegrationRegistry.php](../../../../src/Integrations/IntegrationRegistry.php)
|
||||
|
||||
- [Integrations/IntegrationRegistry.php](../../../../src/Integrations/IntegrationRegistry.php)
|
||||
|
||||
---
|
||||
|
||||
## ~~woocommerce_check_cart_items~~
|
||||
|
||||
|
||||
Fires when cart items are being validated.
|
||||
|
||||
```php
|
||||
do_action( 'woocommerce_check_cart_items' )
|
||||
```
|
||||
|
||||
|
||||
**Deprecated: This hook is deprecated and will be removed**
|
||||
|
||||
|
||||
**Note: Matches action name in WooCommerce core.**
|
||||
|
||||
### Description
|
||||
|
|
@ -361,18 +402,21 @@ do_action( 'woocommerce_check_cart_items' )
|
|||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_created_customer
|
||||
|
||||
|
||||
Fires after a customer account has been registered.
|
||||
|
||||
```php
|
||||
do_action( 'woocommerce_created_customer', integer $customer_id, array $new_customer_data, string $password_generated )
|
||||
```
|
||||
|
||||
|
||||
**Note: Matches filter name in WooCommerce core.**
|
||||
|
||||
### Description
|
||||
|
|
@ -381,20 +425,22 @@ do_action( 'woocommerce_created_customer', integer $customer_id, array $new_cust
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| ------------------- | ------- | --------------------------------------- |
|
||||
| $customer_id | integer | New customer (user) ID. |
|
||||
| $new_customer_data | array | Array of customer (user) data. |
|
||||
| $password_generated | string | The generated password for the account. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $customer_id | integer | New customer (user) ID. |
|
||||
| $new_customer_data | array | Array of customer (user) data. |
|
||||
| $password_generated | string | The generated password for the account. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_no_products_found
|
||||
|
||||
|
||||
Hook: woocommerce_no_products_found.
|
||||
|
||||
```php
|
||||
|
|
@ -403,22 +449,26 @@ do_action( 'woocommerce_no_products_found' )
|
|||
|
||||
### See
|
||||
|
||||
- wc_no_products_found() - Default no products found content (priority 10)
|
||||
|
||||
- wc_no_products_found() - Default no products found content (priority 10)
|
||||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_register_post
|
||||
|
||||
|
||||
Fires before a customer account is registered.
|
||||
|
||||
```php
|
||||
do_action( 'woocommerce_register_post', string $username, string $user_email, \WP_Error $errors )
|
||||
```
|
||||
|
||||
|
||||
**Note: Matches filter name in WooCommerce core.**
|
||||
|
||||
### Description
|
||||
|
|
@ -427,45 +477,22 @@ do_action( 'woocommerce_register_post', string $username, string $user_email, \W
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| ----------- | --------- | ----------------------- |
|
||||
| $username | string | Customer username. |
|
||||
| $user_email | string | Customer email address. |
|
||||
| $errors | \WP_Error | Error object. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $username | string | Customer username. |
|
||||
| $user_email | string | Customer email address. |
|
||||
| $errors | \WP_Error | Error object. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_rest_checkout_process_payment_with_context
|
||||
|
||||
Process payment with context.
|
||||
|
||||
```php
|
||||
do_action_ref_array( 'woocommerce_rest_checkout_process_payment_with_context', [ \Automattic\WooCommerce\StoreApi\Payments\PaymentContext $context, \Automattic\WooCommerce\StoreApi\Payments\PaymentResult $payment_result ] )
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| --------------- | -------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| $context | \Automattic\WooCommerce\StoreApi\Payments\PaymentContext | Holds context for the payment, including order ID and payment method. |
|
||||
| $payment_result | \Automattic\WooCommerce\StoreApi\Payments\PaymentResult | Result object for the transaction. |
|
||||
|
||||
### Exceptions
|
||||
|
||||
`\Exception` If there is an error taking payment, an \Exception object can be thrown with an error message.
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_shop_loop
|
||||
|
||||
|
||||
Hook: woocommerce_shop_loop.
|
||||
|
||||
```php
|
||||
|
|
@ -474,12 +501,14 @@ do_action( 'woocommerce_shop_loop' )
|
|||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
- [BlockTypes/ClassicTemplate.php](../../../../src/BlockTypes/ClassicTemplate.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_cart_errors
|
||||
|
||||
|
||||
Fires an action to validate the cart.
|
||||
|
||||
```php
|
||||
|
|
@ -492,10 +521,10 @@ do_action( 'woocommerce_store_api_cart_errors', \WP_Error $errors, \WC_Cart $car
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| -------- | --------- | ---------------- |
|
||||
| $errors | \WP_Error | WP_Error object. |
|
||||
| $cart | \WC_Cart | Cart object. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $errors | \WP_Error | WP_Error object. |
|
||||
| $cart | \WC_Cart | Cart object. |
|
||||
|
||||
### Example
|
||||
|
||||
|
|
@ -514,14 +543,17 @@ function my_function_callback( $errors, $cart ) {
|
|||
add_action( 'woocommerce_store_api_cart_errors', 'my_function_callback', 10 );
|
||||
```
|
||||
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_cart_select_shipping_rate
|
||||
|
||||
|
||||
Fires an action after a shipping method has been chosen for package(s) via the Store API.
|
||||
|
||||
```php
|
||||
|
|
@ -534,20 +566,22 @@ do_action( 'woocommerce_store_api_cart_select_shipping_rate', string|null $packa
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| ----------- | ---------------- | -------------------------------------------------------------------------------------- |
|
||||
| $package_id | string, null | The sanitized ID of the package being updated. Null if all packages are being updated. |
|
||||
| $rate_id | string | The sanitized chosen rate ID for the package. |
|
||||
| $request | \WP_REST_Request | Full details about the request. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $package_id | string, null | The sanitized ID of the package being updated. Null if all packages are being updated. |
|
||||
| $rate_id | string | The sanitized chosen rate ID for the package. |
|
||||
| $request | \WP_REST_Request | Full details about the request. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/CartSelectShippingRate.php](../../../../src/StoreApi/Routes/V1/CartSelectShippingRate.php)
|
||||
|
||||
- [StoreApi/Routes/V1/CartSelectShippingRate.php](../../../../src/StoreApi/Routes/V1/CartSelectShippingRate.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_cart_update_customer_from_request
|
||||
|
||||
|
||||
Fires when the Checkout Block/Store API updates a customer from the API request data.
|
||||
|
||||
```php
|
||||
|
|
@ -556,19 +590,21 @@ do_action( 'woocommerce_store_api_cart_update_customer_from_request', \WC_Custom
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| --------- | ---------------- | ------------------------------- |
|
||||
| $customer | \WC_Customer | Customer object. |
|
||||
| $request | \WP_REST_Request | Full details about the request. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $customer | \WC_Customer | Customer object. |
|
||||
| $request | \WP_REST_Request | Full details about the request. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/CartUpdateCustomer.php](../../../../src/StoreApi/Routes/V1/CartUpdateCustomer.php)
|
||||
|
||||
- [StoreApi/Routes/V1/CartUpdateCustomer.php](../../../../src/StoreApi/Routes/V1/CartUpdateCustomer.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_cart_update_order_from_request
|
||||
|
||||
|
||||
Fires when the order is synced with cart data from a cart route.
|
||||
|
||||
```php
|
||||
|
|
@ -577,20 +613,22 @@ do_action( 'woocommerce_store_api_cart_update_order_from_request', \WC_Order $dr
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| ------------ | ---------------- | ------------------------------- |
|
||||
| $draft_order | \WC_Order | Order object. |
|
||||
| $customer | \WC_Customer | Customer object. |
|
||||
| $request | \WP_REST_Request | Full details about the request. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $draft_order | \WC_Order | Order object. |
|
||||
| $customer | \WC_Customer | Customer object. |
|
||||
| $request | \WP_REST_Request | Full details about the request. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/AbstractCartRoute.php](../../../../src/StoreApi/Routes/V1/AbstractCartRoute.php)
|
||||
|
||||
- [StoreApi/Routes/V1/AbstractCartRoute.php](../../../../src/StoreApi/Routes/V1/AbstractCartRoute.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_checkout_order_processed
|
||||
|
||||
|
||||
Fires before an order is processed by the Checkout Block/Store API.
|
||||
|
||||
```php
|
||||
|
|
@ -603,9 +641,9 @@ do_action( 'woocommerce_store_api_checkout_order_processed', \WC_Order $order )
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| -------- | --------- | ------------- |
|
||||
| $order | \WC_Order | Order object. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $order | \WC_Order | Order object. |
|
||||
|
||||
### Example
|
||||
|
||||
|
|
@ -621,18 +659,23 @@ function my_function_callback( $order ) {
|
|||
add_action( 'woocommerce_blocks_checkout_order_processed', 'my_function_callback', 10 );
|
||||
```
|
||||
|
||||
|
||||
### See
|
||||
|
||||
- https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/3238
|
||||
|
||||
- https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/3238
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
- [StoreApi/Routes/V1/CheckoutOrder.php](../../../../src/StoreApi/Routes/V1/CheckoutOrder.php)
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_checkout_update_customer_from_request
|
||||
|
||||
|
||||
Fires when the Checkout Block/Store API updates a customer from the API request data.
|
||||
|
||||
```php
|
||||
|
|
@ -641,44 +684,22 @@ do_action( 'woocommerce_store_api_checkout_update_customer_from_request', \WC_Cu
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| --------- | ---------------- | ------------------------------- |
|
||||
| $customer | \WC_Customer | Customer object. |
|
||||
| $request | \WP_REST_Request | Full details about the request. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_checkout_update_order_from_request
|
||||
|
||||
Fires when the Checkout Block/Store API updates an order's from the API request data.
|
||||
|
||||
```php
|
||||
do_action( 'woocommerce_store_api_checkout_update_order_from_request', \WC_Order $order, \WP_REST_Request $request )
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
<p>This hook gives extensions the chance to update orders based on the data in the request. This can be used in conjunction with the ExtendSchema class to post custom data and then process it.</p>
|
||||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---------------- | ------------------------------- |
|
||||
| $order | \WC_Order | Order object. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $customer | \WC_Customer | Customer object. |
|
||||
| $request | \WP_REST_Request | Full details about the request. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
- [StoreApi/Routes/V1/CheckoutOrder.php](../../../../src/StoreApi/Routes/V1/CheckoutOrder.php)
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_checkout_update_order_meta
|
||||
|
||||
|
||||
Fires when the Checkout Block/Store API updates an order's meta data.
|
||||
|
||||
```php
|
||||
|
|
@ -691,22 +712,25 @@ do_action( 'woocommerce_store_api_checkout_update_order_meta', \WC_Order $order
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| -------- | --------- | ------------- |
|
||||
| $order | \WC_Order | Order object. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $order | \WC_Order | Order object. |
|
||||
|
||||
### See
|
||||
|
||||
- https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/3686
|
||||
|
||||
- https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/3686
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_rate_limit_exceeded
|
||||
|
||||
|
||||
Fires when the rate limit is exceeded.
|
||||
|
||||
```php
|
||||
|
|
@ -715,18 +739,20 @@ do_action( 'woocommerce_store_api_rate_limit_exceeded', string $ip_address )
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| ----------- | ------ | ------------------------------ |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $ip_address | string | The IP address of the request. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Authentication.php](../../../../src/StoreApi/Authentication.php)
|
||||
|
||||
- [StoreApi/Authentication.php](../../../../src/StoreApi/Authentication.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_validate_add_to_cart
|
||||
|
||||
|
||||
Fires during validation when adding an item to the cart via the Store API.
|
||||
|
||||
```php
|
||||
|
|
@ -739,19 +765,21 @@ do_action( 'woocommerce_store_api_validate_add_to_cart', \WC_Product $product, a
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| -------- | ----------- | ---------------------------------------------------------------------------- |
|
||||
| $product | \WC_Product | Product object being added to the cart. |
|
||||
| $request | array | Add to cart request params including id, quantity, and variation attributes. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $product | \WC_Product | Product object being added to the cart. |
|
||||
| $request | array | Add to cart request params including id, quantity, and variation attributes. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce_store_api_validate_cart_item
|
||||
|
||||
|
||||
Fire action to validate add to cart. Functions hooking into this should throw an \Exception to prevent add to cart from occurring.
|
||||
|
||||
```php
|
||||
|
|
@ -760,18 +788,20 @@ do_action( 'woocommerce_store_api_validate_cart_item', \WC_Product $product, arr
|
|||
|
||||
### Parameters
|
||||
|
||||
| Argument | Type | Description |
|
||||
| ---------- | ----------- | --------------------------------------- |
|
||||
| $product | \WC_Product | Product object being added to the cart. |
|
||||
| $cart_item | array | Cart item array. |
|
||||
| Argument | Type | Description |
|
||||
| -------- | ---- | ----------- |
|
||||
| $product | \WC_Product | Product object being added to the cart. |
|
||||
| $cart_item | array | Cart item array. |
|
||||
|
||||
### Source
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
- [StoreApi/Utilities/CartController.php](../../../../src/StoreApi/Utilities/CartController.php)
|
||||
|
||||
---
|
||||
|
||||
## woocommerce\_{$product->get_type()}\_add_to_cart
|
||||
## woocommerce_{$product->get_type()}_add_to_cart
|
||||
|
||||
|
||||
Trigger the single product add to cart action for each product type.
|
||||
|
||||
|
|
@ -781,12 +811,14 @@ do_action( 'woocommerce_{$product->get_type()}_add_to_cart' )
|
|||
|
||||
### Source
|
||||
|
||||
- [BlockTypes/AddToCartForm.php](../../../../src/BlockTypes/AddToCartForm.php)
|
||||
|
||||
- [BlockTypes/AddToCartForm.php](../../../../src/BlockTypes/AddToCartForm.php)
|
||||
|
||||
---
|
||||
|
||||
## {$hook}
|
||||
|
||||
|
||||
Action to render the content of a hook.
|
||||
|
||||
```php
|
||||
|
|
@ -795,10 +827,10 @@ do_action( '{$hook}' )
|
|||
|
||||
### Source
|
||||
|
||||
- [Templates/AbstractTemplateCompatibility.php](../../../../src/Templates/AbstractTemplateCompatibility.php)
|
||||
|
||||
- [Templates/AbstractTemplateCompatibility.php](../../../../src/Templates/AbstractTemplateCompatibility.php)
|
||||
|
||||
---
|
||||
|
||||
<!-- FEEDBACK -->
|
||||
|
||||
---
|
||||
|
|
@ -808,3 +840,4 @@ do_action( '{$hook}' )
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/hooks/actions.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -80,3 +80,4 @@ The main products endpoint is extensible via ExtendSchema. The data is available
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/rest-api/available-endpoints-to-extend.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -337,3 +337,4 @@ You may wish to use our pre-existing Formatters to ensure your data is passed th
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/rest-api/extend-rest-api-add-data.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -142,3 +142,4 @@ alert('bad script!') This “coffee” is <strong>very strong</strong>.
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/rest-api/extend-rest-api-formatters.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -49,3 +49,4 @@ Extending a new endpoint is usually half the work, you will need to receive this
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/rest-api/extend-rest-api-new-endpoint.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -192,3 +192,4 @@ Now that this is registered, when the button is pressed, the `cart/extensions` e
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/third-party-developers/extensibility/rest-api/extend-rest-api-update-cart.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -62,3 +62,4 @@ This package contains the following directories. Navigate to a directory for mor
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./packages/checkout/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -212,3 +212,4 @@ const isValid = hasInnerBlocks( 'woocommerce/checkout-totals-block' ); // true
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./packages/checkout/blocks-registry/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -29,3 +29,4 @@ These components are here so they can be consumed by extensions.
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./packages/checkout/components/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -132,3 +132,4 @@ Filters are implemented throughout the Mini-Cart, Cart and Checkout Blocks, as w
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./packages/checkout/filter-registry/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -192,3 +192,4 @@ Slot Fills are implemented throughout the Cart and Checkout Blocks, as well as s
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./packages/checkout/slot/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -81,3 +81,4 @@ What value must contain. If this is not found within `value`, and error will be
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./packages/checkout/utils/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -172,3 +172,4 @@ If you're looking to add _new routes and endpoints_, rather than extending the S
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/README.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -171,3 +171,4 @@ curl --request DELETE https://example-store.com/wp-json/wc/store/v1/cart/coupons
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/cart-coupons.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -369,3 +369,4 @@ curl --request DELETE https://example-store.com/wp-json/wc/store/v1/cart/items
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/cart-items.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -551,3 +551,4 @@ Returns the full [Cart Response](#cart-response) on success, or an [Error Respon
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/cart.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -227,3 +227,4 @@ For further information on generating a `stripe_source` please check [the Stripe
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/checkout.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -140,3 +140,4 @@ The version will not increase for bug fixes unless the scope of the bug causes a
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/guiding-principles.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -56,3 +56,4 @@ NOTE: This should only be done on development sites where security is not import
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/nonce-tokens.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -43,3 +43,4 @@ curl "https://example-store.com/wp-json/wc/store/v1/products/attributes/1/terms"
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/product-attribute-terms.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -78,3 +78,4 @@ curl "https://example-store.com/wp-json/wc/store/v1/products/attributes/1"
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/product-attributes.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -95,3 +95,4 @@ curl "https://example-store.com/wp-json/wc/store/v1/products/categories/1"
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/product-categories.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -73,3 +73,4 @@ curl "https://example-store.com/wp-json/wc/store/v1/products/collection-data?cal
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/product-collection-data.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -72,3 +72,4 @@ curl "https://example-store.com/wp-json/wc/store/v1/products/collection-data?cal
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/product-reviews.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -48,3 +48,4 @@ Example response:
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/product-tags.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -279,3 +279,4 @@ curl "https://example-store.com/wp-json/wc/store/v1/products?type=variation"
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/products.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
|
|
@ -84,13 +84,6 @@ add_action(
|
|||
);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
|
||||
|
||||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-gutenberg-products-block/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/rate-limiting.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
<!-- FEEDBACK -->
|
||||
|
||||
---
|
||||
|
|
@ -100,3 +93,4 @@ add_action(
|
|||
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./src/StoreApi/docs/rate-limiting.md)
|
||||
|
||||
<!-- /FEEDBACK -->
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue