Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Cart/Checkout/Order-Received Templates (https://github.com/woocommerce/woocommerce-blocks/pull/9301) 

* WIP: dirty attempt to dry run Cart & Checkout templates

* Added Cart and Checkout to the template hierarchies

* Merge branch 'trunk' into poc/cart_and_checkout_fse_templates

* Updated cart & Checkout templates

* Order Received FSE template (https://github.com/woocommerce/woocommerce-blocks/pull/8937)

* Order Received template bootstrap

* typo

* WIP: new block

* add logic here

* Order received classic template

* reverted constants.ts

* Added the post title (buggy)

* Corrected page title

* Updated constants.ts

* Fixed template typo

* removed placeholder for order received block

* add order-received template description

* updated placeholder description

* Formatting fixes

* Template description.

* replaced hardcoded string with OrderReceivedTemplate::SLUG

---------

Co-authored-by: Luigi <gigitux@gmail.com>

* Code formatting (https://github.com/woocommerce/woocommerce-blocks/pull/8350)

* Code formatting

* page_template_hierarchy priority to 1 (https://github.com/woocommerce/woocommerce-blocks/pull/9323)

Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com>

* Migrate Cart and Checkout Pages to the Template Editor when using a FSE theme (https://github.com/woocommerce/woocommerce-blocks/pull/9339)

* Introduce woocommerce_blocks_template_content hook

* Migrate cart and checkout page content to the template editor

* Add redirection from edit page to edit template

---------

Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com>

* Removed header and footer from checkout template. (https://github.com/woocommerce/woocommerce-blocks/pull/9378)

* Removed header and footer from checkout template.

* Removed header and footer from checkout template migration

* Permalink solution for the checkout endpoint/template (https://github.com/woocommerce/woocommerce-blocks/pull/9406)

* Checkout endpoint work

* Move setting field to util

* Include link to edit the template

* Remove todo

* Refactor checkout templates to share logic (https://github.com/woocommerce/woocommerce-blocks/pull/9411)

* Sync endpoints with pages (https://github.com/woocommerce/woocommerce-blocks/pull/9426)

* Switch to page syncing

* Update settings descriptions

---------

Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com>

* Migrate pages to templates once (https://github.com/woocommerce/woocommerce-blocks/pull/9488)

* Migrate content on init, once

* Skip migration if page does not exist

* Put back HTML for header and footer parts

* Fix page redirect due to wrong ID

* fix loading template part

* Removed unnecessary var

* update cart and checkout html templates

---------

Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com>

* Include a notice to redirect user to template editor (https://github.com/woocommerce/woocommerce-blocks/pull/9508)

* Template Placeholder Design for the Order Received Template (https://github.com/woocommerce/woocommerce-blocks/pull/9602)

* Load frontend styles in editor iframe

* Update placeholder to include skeleton and updated icons

* Update classic template configs

* 1px border for .wp-block-woocommerce-classic-template__placeholder-copy

* Show copy on focus

* Sample data

---------

Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com>

* Add simplified header on checkout template (https://github.com/woocommerce/woocommerce-blocks/pull/9607)

* Added simplified header on checkout template

* Moved simplified header to template part

* updated constants.ts

* added template part to checkout.html

* Add missing translation

* frontpage_template_hierarchy no longer needed

* Allow plugin based template parts (https://github.com/woocommerce/woocommerce-blocks/pull/9667)

* Merge branch 'trunk' into add/9288_cart-checkout-order-received_fse_templates

* Synced templates on blockified folder

* Add blockified order-received.html

* removed WooCommerce prefix

* Refactor/rebrand order received template to order confirmation (https://github.com/woocommerce/woocommerce-blocks/pull/9734)

* rebrand order received to order confirmation

* updated descriptions for templates

* updated descriptions for order confirmation placeholder

* Resolve merge conflict

* Resolve merge conflicts

* Resolve more merge conflicts after rebase

* Fix formatting

* Use patterns for localisation (https://github.com/woocommerce/woocommerce-blocks/pull/9883)

* e2e tests for cart and checkout templates (https://github.com/woocommerce/woocommerce-blocks/pull/9939)

* Merge branch 'trunk' into poc/cart_and_checkout_fse_templates

* Merge branch 'trunk' into add/9288_cart-checkout-order-received_fse_templates

* Resolve merge conflicts

* Add e2e for permalink settings

* Test that templates exist

* Add test to check that templates can be edited

* Add tests to confirm templates can be edited

* Ensure cart has contents before running tests on frontend views

* Commend out problem test

* Make sure search has multiple results

* Remove useThrottle - bad rebase

* Revert changes to docs after rebase

* Revert function call for noReviewsPlaceholder

* Bad rebase

* Reverts

* Remove revertTemplate

* Spacing

* Wait for networkidle after navigation

* Always wait for network

* Use button roles in site editor

* More specific button locator

* Update option comparison

* Fix template content

* Disable failing tests

* Disable failing classic template tests

* Use enterEditMode

* More enterEditMode usage

* enterEditMode

* Use test.skip

* More robust selectors

* Alt iframe selector

---------

Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com>

* Skip flakey test

---------

Co-authored-by: Luigi <gigitux@gmail.com>
Co-authored-by: Mike Jolley <mike.jolley@me.com>
This commit is contained in:
Paulo Arromba 2023-06-29 14:41:22 +01:00 committed by GitHub
parent 6d36b2547b
commit f1df8fb975
100 changed files with 2926 additions and 1346 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce-blocks/.github/patch-initial-checklist.md vendored
View File

@ -74,8 +74,8 @@ This only needs done if the patch release needs to be included in WooCommerce Co
- [ ] Create a pull request for updating the package in WooCommerce core (based off of the WooCommerce core release branch this is deployed for).
- [ ] Set the base branch (the branch that your PR will be merged into) to the correct one. It must be:
- `trunk` if the WC Blocks version you are releasing is higher than the one in core (you can find the current WC Blocks version in core in `plugins/woocommerce/composer.json`)
- `release/x.y` if the WC Blocks version in core is higher than the one you are releasing (`x.y` must be the version of WC core that will include the version of WC Blocks you are releasing)
- `trunk` if the WC Blocks version you are releasing is higher than the one in core (you can find the current WC Blocks version in core in `plugins/woocommerce/composer.json`)
- `release/x.y` if the WC Blocks version in core is higher than the one you are releasing (`x.y` must be the version of WC core that will include the version of WC Blocks you are releasing)
- The content for the pull release can follow [this example](https://github.com/woocommerce/woocommerce/pull/32627).
- [ ] Increase the version of `woocommerce/woocommerce-blocks` in the `plugins/woocommerce/composer.json` file

2
plugins/woocommerce-blocks/.github/release-initial-checklist.md vendored
View File

@ -107,13 +107,13 @@ This only needs to be done if this release is the last release of the feature pl
- It lists all the WooCommerce Blocks versions that are being included since the last version that you edited in `plugins/woocommerce/composer.json`. Each version should have a link for the `Release PR`, `Testing instructions` and `Release post` (if available).
- The changelog should be aggregated from all the releases included in the package bump and grouped per type: `Enhancements`, `Bug Fixes`, `Various` etc. This changelog will be used in the release notes for the WooCommerce release. That's why it should only list the PRs that have WooCoomerce Core in the WooCommerce Visibility section of their description. Don't include changes available in the feature plugin or development builds.
- [ ] Build WC core from that branch with `pnpm run --filter='woocommerce' build ` (you might need to [install the dependencies first](https://github.com/woocommerce/woocommerce#prerequisites)) and:
- [ ] Make sure the correct version of WC Blocks is being loaded. This can be done testing at least one of the testing steps from the release.
- [ ] Complete the [Smoke testing checklist](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/trunk/docs/internal-developers/testing/smoke-testing.md).
- [ ] Verify and make any additional edits to the pull request description for things like: Changelog to be included with WooCommerce core, additional communication that might be needed elsewhere, additional marketing communication notes that may be needed, etc.
- [ ] Assign the corresponding WC version milestone to the PR
- [ ] After the checklist is complete and the testing is done, select the porter of your team to review the PR. Once approved, make sure you merge the PR.

26
plugins/woocommerce-blocks/assets/js/blocks/cart-checkout-shared/sidebar-notices/index.tsx
View File

@ -12,10 +12,13 @@ import { CartCheckoutSidebarCompatibilityNotice } from '@woocommerce/editor-comp
import { NoPaymentMethodsNotice } from '@woocommerce/editor-components/no-payment-methods-notice';
import { PAYMENT_STORE_KEY } from '@woocommerce/block-data';
import { DefaultNotice } from '@woocommerce/editor-components/default-notice';
import { TemplateNotice } from '@woocommerce/editor-components/template-notice';
import { IncompatiblePaymentGatewaysNotice } from '@woocommerce/editor-components/incompatible-payment-gateways-notice';
import { useSelect } from '@wordpress/data';
import { CartCheckoutFeedbackPrompt } from '@woocommerce/editor-components/feedback-prompt';
import { useState } from '@wordpress/element';
import { getSetting } from '@woocommerce/settings';
declare module '@wordpress/editor' {
let store: StoreDescriptor;
}
@ -36,6 +39,8 @@ const withSidebarNotices = createHigherOrderComponent(
isSelected: isBlockSelected,
} = props;
const isBlockTheme = getSetting( 'isBlockTheme' );
const [
isIncompatiblePaymentGatewaysNoticeDismissed,
setIsIncompatiblePaymentGatewaysNoticeDismissed,
@ -101,15 +106,20 @@ const withSidebarNotices = createHigherOrderComponent(
}
/>
{ isBlockTheme ? (
<TemplateNotice
block={ isCheckout ? 'checkout' : 'cart' }
/>
) : (
<DefaultNotice
block={ isCheckout ? 'checkout' : 'cart' }
/>
) }
{ isIncompatiblePaymentGatewaysNoticeDismissed ? (
<>
<DefaultNotice
block={ isCheckout ? 'checkout' : 'cart' }
/>
<CartCheckoutSidebarCompatibilityNotice
block={ isCheckout ? 'checkout' : 'cart' }
/>
</>
<CartCheckoutSidebarCompatibilityNotice
block={ isCheckout ? 'checkout' : 'cart' }
/>
) : null }
{ isPaymentMethodsBlock && ! hasPaymentMethods && (

22
plugins/woocommerce-blocks/assets/js/blocks/classic-template/archive-product.ts
View File

@ -147,18 +147,26 @@ const onClickCallbackWithTermDescription = ( {
}
};
export const blockifiedProductCatalogConfig = {
getBlockifiedTemplate,
isConversionPossible,
getDescription,
const productCatalogBlockifyConfig = {
getButtonLabel,
onClickCallback,
getBlockifiedTemplate,
};
const productTaxonomyBlockifyConfig = {
getButtonLabel,
onClickCallback: onClickCallbackWithTermDescription,
getBlockifiedTemplate: getBlockifiedTemplateWithTermDescription,
};
export const blockifiedProductCatalogConfig = {
isConversionPossible,
getDescription,
blockifyConfig: productCatalogBlockifyConfig,
};
export const blockifiedProductTaxonomyConfig = {
getBlockifiedTemplate: getBlockifiedTemplateWithTermDescription,
onClickCallback: onClickCallbackWithTermDescription,
isConversionPossible,
getDescription,
getButtonLabel,
blockifyConfig: productTaxonomyBlockifyConfig,
};

26
plugins/woocommerce-blocks/assets/js/blocks/classic-template/constants.ts
View File

@ -14,10 +14,16 @@ export const TYPES = {
productCatalog: 'product-catalog',
productTaxonomy: 'product-taxonomy',
productSearchResults: 'product-search-results',
orderConfirmation: 'order-confirmation',
cart: 'cart',
checkout: 'checkout',
checkoutHeader: 'checkout-header',
};
export const PLACEHOLDERS = {
singleProduct: 'single-product',
archiveProduct: 'archive-product',
orderConfirmation: 'fallback',
checkoutHeader: 'checkout-header',
};
export const TEMPLATES: TemplateDetails = {
@ -69,4 +75,24 @@ export const TEMPLATES: TemplateDetails = {
),
placeholder: PLACEHOLDERS.archiveProduct,
},
cart: {
type: TYPES.cart,
title: __( 'WooCommerce Cart Block', 'woo-gutenberg-products-block' ),
placeholder: 'cart',
},
checkout: {
type: TYPES.checkout,
title: __( 'Checkout Block', 'woo-gutenberg-products-block' ),
placeholder: 'checkout',
},
'checkout-header': {
type: TYPES.checkoutHeader,
title: __( 'Checkout Header', 'woo-gutenberg-products-block' ),
placeholder: 'checkout-header',
},
'order-confirmation': {
type: TYPES.orderConfirmation,
title: __( 'Order Confirmation Block', 'woo-gutenberg-products-block' ),
placeholder: PLACEHOLDERS.orderConfirmation,
},
};

111
plugins/woocommerce-blocks/assets/js/blocks/classic-template/editor.scss
View File

@ -3,55 +3,86 @@
margin-right: auto;
}
.wp-block-woocommerce-classic-template__placeholder-copy {
display: flex;
flex-direction: column;
max-width: 900px;
width: 400px;
margin: auto;
}
.wp-block-woocommerce-classic-template__placeholder-warning {
border-left: 5px solid #2181d2;
padding-left: em(40px);
}
.wp-block-woocommerce-classic-template__placeholder-wireframe {
height: 250px;
background: #e5e5e5;
display: flex;
flex-wrap: wrap;
gap: $gap-large;
margin: auto;
@media only screen and (min-width: 768px) {
height: auto;
background: transparent;
}
.wp-block-woocommerce-classic-template__placeholder .components-placeholder__fieldset {
display: grid;
grid-template-columns: 1fr;
}
.wp-block-woocommerce-classic-template__placeholder .wp-block-woocommerce-classic-template__placeholder-image {
display: none;
.wp-block-woocommerce-classic-template__placeholder-wireframe,
.wp-block-woocommerce-classic-template__placeholder-copy {
grid-row-start: 1;
grid-column-start: 1;
transition: 0.3s all ease;
}
.wp-block-woocommerce-classic-template__placeholder-copy {
border: 1px solid $gray-900;
background-color: #fff;
padding: $gap-large $gap-larger;
border-radius: 3px;
display: flex;
flex-direction: column;
max-width: 900px;
width: 400px;
height: auto;
margin: auto;
opacity: 0;
z-index: 10;
@media only screen and (min-width: 768px) {
display: block;
.wp-block-woocommerce-classic-template__placeholder-copy__icon-container {
margin: 0 0 $gap;
span {
@include font-size(larger);
display: block;
}
.woo-icon {
color: #{$studio-woocommerce-purple};
@include font-size(large);
svg {
vertical-align: middle;
}
}
}
p {
margin: 0 0 $gap;
}
.wp-block-woocommerce-classic-template__placeholder-migration-button-container {
justify-content: center;
margin: $gap 0;
}
}
.wp-block-woocommerce-classic-template__placeholder-wireframe {
pointer-events: none;
// Image based placeholders should fill horizontal width.
> img {
width: 100%;
}
}
.wp-block-woocommerce-classic-template__placeholder-migration-button-container {
justify-content: center;
align-items: center;
margin: 0 auto;
}
.wp-block-woocommerce-classic-template__placeholder-copy__icon-container {
display: flex;
align-items: center;
gap: $gap-small;
span {
@include font-size(larger);
.wp-block-woocommerce-legacy-template {
.components-placeholder {
box-shadow: none;
padding: 0;
}
}
.wp-block-woocommerce-legacy-template.is-selected {
.wp-block-woocommerce-classic-template__placeholder-wireframe {
filter: blur(3px);
opacity: 0.5;
* {
color: $gray-200 !important;
border-color: $gray-200 !important;
}
}
.wp-block-woocommerce-classic-template__placeholder-copy {
opacity: 1;
}
.components-placeholder {
box-shadow: inherit;
}
}

287
plugins/woocommerce-blocks/assets/js/blocks/classic-template/index.tsx
View File

@ -30,6 +30,7 @@ import { useEffect, useState } from '@wordpress/element';
import { store as noticesStore } from '@wordpress/notices';
import { useEntityRecord } from '@wordpress/core-data';
import { debounce } from '@woocommerce/base-utils';
import { woo } from '@woocommerce/icons';
/**
* Internal dependencies
@ -48,6 +49,8 @@ import {
} from './archive-product';
import * as blockifiedSingleProduct from './single-product';
import * as blockifiedProductSearchResults from './product-search-results';
import * as blockifiedOrderConfirmation from './order-confirmation';
import type { BlockifiedTemplateConfig } from './types';
type Attributes = {
@ -59,7 +62,6 @@ const blockifiedFallbackConfig = {
isConversionPossible: () => false,
getBlockifiedTemplate: () => [],
getDescription: () => '',
getButtonLabel: () => '',
onClickCallback: () => void 0,
};
@ -68,6 +70,7 @@ const conversionConfig: { [ key: string ]: BlockifiedTemplateConfig } = {
[ TYPES.productTaxonomy ]: blockifiedProductTaxonomyConfig,
[ TYPES.singleProduct ]: blockifiedSingleProduct,
[ TYPES.productSearchResults ]: blockifiedProductSearchResults,
[ TYPES.orderConfirmation ]: blockifiedOrderConfirmation,
fallback: blockifiedFallbackConfig,
};
@ -80,17 +83,121 @@ const pickBlockClientIds = ( blocks: Array< BlockInstance > ) =>
return [ ...acc, block.clientId ];
}, [] );
const ConvertTemplate = ( { blockifyConfig, clientId, attributes } ) => {
const { getButtonLabel, onClickCallback, getBlockifiedTemplate } =
blockifyConfig;
const [ isPopoverOpen, setIsPopoverOpen ] = useState( false );
const { replaceBlock, selectBlock, replaceBlocks } =
useDispatch( blockEditorStore );
const { getBlocks } = useSelect( ( sel ) => {
return {
getBlocks: sel( blockEditorStore ).getBlocks,
};
}, [] );
const { createInfoNotice } = useDispatch( noticesStore );
return (
<div className="wp-block-woocommerce-classic-template__placeholder-migration-button-container">
<Button
isPrimary
onClick={ () => {
onClickCallback( {
clientId,
getBlocks,
attributes,
replaceBlock,
selectBlock,
} );
createInfoNotice(
__(
'Template transformed into blocks!',
'woo-gutenberg-products-block'
),
{
actions: [
{
label: __(
'Undo',
'woo-gutenberg-products-block'
),
onClick: () => {
const clientIds = pickBlockClientIds(
getBlocks()
);
replaceBlocks(
clientIds,
createBlock(
'core/group',
{
layout: {
inherit: true,
type: 'constrained',
},
},
[
createBlock(
'woocommerce/legacy-template',
{
template:
attributes.template,
}
),
]
)
);
},
},
],
type: 'snackbar',
}
);
} }
onMouseEnter={ () => setIsPopoverOpen( true ) }
onMouseLeave={ () => setIsPopoverOpen( false ) }
text={ getButtonLabel ? getButtonLabel() : '' }
>
{ isPopoverOpen && (
<Popover resize={ false } placement="right-end">
<div
style={ {
minWidth: '250px',
width: '250px',
maxWidth: '250px',
minHeight: '300px',
height: '300px',
maxHeight: '300px',
cursor: 'pointer',
} }
>
<BlockPreview
blocks={ getBlockifiedTemplate( attributes ) }
viewportWidth={ 1200 }
additionalStyles={ [
{
css: 'body { padding: 20px !important; height: fit-content !important; overflow:hidden}',
},
] }
/>
</div>
</Popover>
) }
</Button>
</div>
);
};
const Edit = ( {
clientId,
attributes,
setAttributes,
}: BlockEditProps< Attributes > ) => {
const { replaceBlock, selectBlock, replaceBlocks } =
useDispatch( blockEditorStore );
const { getBlocks, editedPostId } = useSelect( ( sel ) => {
const blockProps = useBlockProps();
const { editedPostId } = useSelect( ( sel ) => {
return {
getBlocks: sel( blockEditorStore ).getBlocks,
editedPostId: sel( 'core/edit-site' ).getEditedPostId(),
};
}, [] );
@ -103,9 +210,6 @@ const Edit = ( {
};
} >( 'postType', 'wp_template', editedPostId );
const { createInfoNotice } = useDispatch( noticesStore );
const blockProps = useBlockProps();
const templateDetails = getTemplateDetailsBySlug(
attributes.template,
TEMPLATES
@ -127,136 +231,63 @@ const Edit = ( {
const {
isConversionPossible,
getDescription,
getButtonLabel,
onClickCallback,
getBlockifiedTemplate,
getSkeleton,
blockifyConfig,
} = conversionConfig[ templateType ];
const skeleton = getSkeleton ? (
getSkeleton()
) : (
<img
className="wp-block-woocommerce-classic-template__placeholder-image"
src={ `${ WC_BLOCKS_IMAGE_URL }template-placeholders/${ templatePlaceholder }.svg` }
alt={ templateTitle }
/>
);
const canConvert = isConversionPossible();
const placeholderDescription = getDescription( templateTitle, canConvert );
const [ isPopoverOpen, setIsPopoverOpen ] = useState( false );
return (
<div { ...blockProps }>
<Placeholder className="wp-block-woocommerce-classic-template__placeholder">
<div className="wp-block-woocommerce-classic-template__placeholder-wireframe">
<div className="wp-block-woocommerce-classic-template__placeholder-copy">
<div className="wp-block-woocommerce-classic-template__placeholder-copy__icon-container">
<Icon icon={ box } />
<span>
{ __(
'Classic Product Template',
'woo-gutenberg-products-block'
) }
</span>
</div>
<p>{ placeholderDescription }</p>
{ canConvert && (
<div className="wp-block-woocommerce-classic-template__placeholder-migration-button-container">
<Button
isPrimary
onClick={ () => {
onClickCallback( {
clientId,
getBlocks,
attributes,
replaceBlock,
selectBlock,
} );
createInfoNotice(
__(
'Template transformed into blocks!',
'woo-gutenberg-products-block'
),
{
actions: [
{
label: __(
'Undo',
'woo-gutenberg-products-block'
),
onClick: () => {
const clientIds =
pickBlockClientIds(
getBlocks()
);
replaceBlocks(
clientIds,
createBlock(
'core/group',
{
layout: {
inherit:
true,
type: 'constrained',
},
},
[
createBlock(
'woocommerce/legacy-template',
{
template:
attributes.template,
}
),
]
)
);
},
},
],
type: 'snackbar',
}
);
} }
onMouseEnter={ () =>
setIsPopoverOpen( true )
}
onMouseLeave={ () =>
setIsPopoverOpen( false )
}
text={ getButtonLabel() }
>
{ isPopoverOpen && (
<Popover
resize={ false }
placement="right-end"
>
<div
style={ {
minWidth: '250px',
width: '250px',
maxWidth: '250px',
minHeight: '300px',
height: '300px',
maxHeight: '300px',
cursor: 'pointer',
} }
>
<BlockPreview
blocks={ getBlockifiedTemplate(
attributes
) }
viewportWidth={ 1200 }
additionalStyles={ [
{
css: 'body { padding: 20px !important; height: fit-content !important; overflow:hidden}',
},
] }
/>
</div>
</Popover>
) }
</Button>
</div>
) }
{ skeleton }
</div>
<div className="wp-block-woocommerce-classic-template__placeholder-copy">
<div className="wp-block-woocommerce-classic-template__placeholder-copy__icon-container">
<span className="woo-icon">
<Icon icon={ woo } />{ ' ' }
{ __(
'WooCommerce',
'woo-gutenberg-products-block'
) }
</span>
<span>
{ __(
'Classic Template Placeholder',
'woo-gutenberg-products-block'
) }
</span>
</div>
<img
className="wp-block-woocommerce-classic-template__placeholder-image"
src={ `${ WC_BLOCKS_IMAGE_URL }template-placeholders/${ templatePlaceholder }.svg` }
alt={ templateTitle }
<p
dangerouslySetInnerHTML={ {
__html: placeholderDescription,
} }
/>
<p>
{ __(
'You cannot edit the content of this block. However, you can move it and place other blocks around it.',
'woo-gutenberg-products-block'
) }
</p>
{ canConvert && blockifyConfig && (
<ConvertTemplate
clientId={ clientId }
blockifyConfig={ blockifyConfig }
attributes={ attributes }
/>
) }
</div>
</Placeholder>
</div>

153
plugins/woocommerce-blocks/assets/js/blocks/classic-template/order-confirmation.tsx Normal file
View File

@ -0,0 +1,153 @@
/**
* External dependencies
*/
import { __ } from '@wordpress/i18n';
const isConversionPossible = () => {
return false;
};
const getDescription = () => {
return __(
'This block represents the classic template used to display the order confirmation. The actual rendered template may appear different from this placeholder.',
'woo-gutenberg-products-block'
);
};
const getSkeleton = () => {
return (
<div className="woocommerce-page">
<div className="woocommerce-order">
<h1>
{ __( 'Order received', 'woo-gutenberg-products-block' ) }
</h1>
<p className="woocommerce-notice woocommerce-notice--success woocommerce-thankyou-order-confirmation">
{ __(
'Thank you. Your order has been received.',
'woo-gutenberg-products-block'
) }
</p>
<ul className="woocommerce-order-overview woocommerce-thankyou-order-details order_details">
<li className="woocommerce-order-overview__order order">
{ __( 'Order number', 'woo-gutenberg-products-block' ) }
: <strong>123</strong>
</li>
<li className="woocommerce-order-overview__date date">
{ __( 'Date', 'woo-gutenberg-products-block' ) }:{ ' ' }
<strong>May 25, 2023</strong>
</li>
<li className="woocommerce-order-overview__email email">
{ __( 'Email', 'woo-gutenberg-products-block' ) }:{ ' ' }
<strong>shopper@woo.com</strong>
</li>
<li className="woocommerce-order-overview__total total">
{ __( 'Total', 'woo-gutenberg-products-block' ) }:{ ' ' }
<strong>$20.00</strong>
</li>
</ul>
<section className="woocommerce-order-details">
<h2 className="woocommerce-order-details__title">
{ __(
'Order details',
'woo-gutenberg-products-block'
) }
</h2>
<table className="woocommerce-table woocommerce-table--order-details shop_table order_details">
<thead>
<tr>
<th className="woocommerce-table__product-name product-name">
{ __(
'Product',
'woo-gutenberg-products-block'
) }
</th>
<th className="woocommerce-table__product-table product-total">
{ __(
'Total',
'woo-gutenberg-products-block'
) }
</th>
</tr>
</thead>
<tbody>
<tr className="woocommerce-table__line-item order_item">
<td className="woocommerce-table__product-name product-name">
Sample Product{ ' ' }
<strong className="product-quantity">
×&nbsp;2
</strong>{ ' ' }
</td>
<td className="woocommerce-table__product-total product-total">
$20.00
</td>
</tr>
</tbody>
<tfoot>
<tr>
<th scope="row">
{ __(
'Subtotal',
'woo-gutenberg-products-block'
) }
:
</th>
<td>$20.00</td>
</tr>
<tr>
<th scope="row">
{ __(
'Total',
'woo-gutenberg-products-block'
) }
:
</th>
<td>$20.00</td>
</tr>
</tfoot>
</table>
</section>
<section className="woocommerce-customer-details">
<section className="woocommerce-columns woocommerce-columns--2 woocommerce-columns--addresses col2-set addresses">
<div className="woocommerce-column woocommerce-column--1 woocommerce-column--billing-address col-1">
<h2 className="woocommerce-column__title">
{ __(
'Billing address',
'woo-gutenberg-products-block'
) }
</h2>
<address>
123 Main St
<br />
New York, NY 10001
<br />
United States (US)
</address>
</div>
<div className="woocommerce-column woocommerce-column--2 woocommerce-column--shipping-address col-2">
<h2 className="woocommerce-column__title">
{ __(
'Shipping address',
'woo-gutenberg-products-block'
) }
</h2>
<address>
123 Main St
<br />
New York, NY 10001
<br />
United States (US)
</address>
</div>
</section>
</section>
</div>
</div>
);
};
export { isConversionPossible, getDescription, getSkeleton };

8
plugins/woocommerce-blocks/assets/js/blocks/classic-template/product-search-results.ts
View File

@ -169,10 +169,10 @@ const onClickCallback = ( {
const getButtonLabel = () =>
__( 'Transform into blocks', 'woo-gutenberg-products-block' );
export {
getBlockifiedTemplate,
isConversionPossible,
getDescription,
const blockifyConfig = {
getButtonLabel,
onClickCallback,
getBlockifiedTemplate,
};
export { isConversionPossible, getDescription, blockifyConfig };

8
plugins/woocommerce-blocks/assets/js/blocks/classic-template/single-product.ts
View File

@ -114,10 +114,10 @@ const onClickCallback = ( {
}
};
export {
getBlockifiedTemplate,
isConversionPossible,
getDescription,
const blockifyConfig = {
getButtonLabel,
onClickCallback,
getBlockifiedTemplate,
};
export { isConversionPossible, getDescription, blockifyConfig };

27
plugins/woocommerce-blocks/assets/js/blocks/classic-template/types.ts
View File

@ -3,7 +3,13 @@
*/
import { type BlockInstance } from '@wordpress/blocks';
export type TemplateDetails = Record< string, Record< string, string > >;
type TemplateDetail = {
type: string;
title: string;
placeholder: string;
};
export type TemplateDetails = Record< string, TemplateDetail >;
export type InheritedAttributes = {
align?: string;
@ -17,12 +23,21 @@ export type OnClickCallbackParameter = {
selectBlock: ( clientId: string ) => void;
};
export type BlockifiedTemplateConfig = {
type ConversionConfig = {
onClickCallback: ( params: OnClickCallbackParameter ) => void;
getButtonLabel: () => string;
getBlockifiedTemplate: (
inheritedAttributes: InheritedAttributes
) => BlockInstance[];
isConversionPossible: () => boolean;
getDescription: ( templateTitle: string, canConvert: boolean ) => string;
getButtonLabel: () => string;
onClickCallback: ( params: OnClickCallbackParameter ) => void;
};
export type BlockifiedTemplateConfig = {
// Description of the template, shown in the block placeholder.
getDescription: ( templateTitle: string, canConvert: boolean ) => string;
// Returns the skeleton HTML for the template, or can be left blank to use the default fallback image.
getSkeleton?: ( () => JSX.Element ) | undefined;
// Is conversion possible for the template?
isConversionPossible: () => boolean;
// If conversion is possible, returns the config for the template to be blockified.
blockifyConfig?: ConversionConfig | undefined;
};

14
plugins/woocommerce-blocks/assets/js/editor-components/template-notice/editor.scss Normal file
View File

@ -0,0 +1,14 @@
.wc-default-template-notice.is-dismissible {
margin: 0;
padding-right: 16px;
.components-notice__dismiss {
min-width: 24px;
}
.components-notice__content {
margin: 4px 0;
}
svg {
width: 16px;
height: 16px;
}
}

54
plugins/woocommerce-blocks/assets/js/editor-components/template-notice/index.tsx Normal file
View File

@ -0,0 +1,54 @@
/**
* External dependencies
*/
import { __, sprintf } from '@wordpress/i18n';
import { Notice, Button } from '@wordpress/components';
import { useState } from '@wordpress/element';
import { isSiteEditorPage } from '@woocommerce/utils';
import { select } from '@wordpress/data';
import { getSetting } from '@woocommerce/settings';
/**
* Internal dependencies
*/
import './editor.scss';
export function TemplateNotice( { block }: { block: string } ) {
const [ settingStatus, setStatus ] = useState( 'pristine' );
const store = select( 'core/edit-site' );
if ( settingStatus === 'dismissed' || isSiteEditorPage( store ) ) {
return null;
}
const editUrl = `${ getSetting(
'adminUrl'
) }site-editor.php?postType=wp_template&postId=woocommerce%2Fwoocommerce%2F%2F${ block }`;
const noticeContent = sprintf(
// translators: %s: cart or checkout page name.
__(
'The default %s can be customized in the Site Editor',
'woo-gutenberg-products-block'
),
block === 'checkout'
? __( 'checkout', 'woo-gutenberg-products-block' )
: __( 'cart', 'woo-gutenberg-products-block' )
);
return (
<Notice
className="wc-default-template-notice"
status={ 'warning' }
onRemove={ () => setStatus( 'dismissed' ) }
spokenMessage={ noticeContent }
>
<>
<p>{ noticeContent }</p>
<Button href={ editUrl } variant="secondary" isSmall={ true }>
{ __( 'Edit template', 'woo-gutenberg-products-block' ) }
</Button>
</>
</Notice>
);
}

7
plugins/woocommerce-blocks/docs/designers/theming/cart-and-checkout.md
View File

@ -2,9 +2,9 @@
## Table of Contents <!-- omit in toc -->
- [Buttons](#buttons)
- [Mobile submit container](#mobile-submit-container)
- [Item quantity badge](#item-quantity-badge)
- [Buttons](#buttons)
- [Mobile submit container](#mobile-submit-container)
- [Item quantity badge](#item-quantity-badge)
## Buttons
@ -87,4 +87,3 @@ 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 -->

5
plugins/woocommerce-blocks/docs/designers/theming/class-names-update-280.md
View File

@ -2,8 +2,8 @@
## Table of Contents <!-- omit in toc -->
- [Replaced classes](#replaced-classes)
- [Deprecated classes](#deprecated-classes)
- [Replaced classes](#replaced-classes)
- [Deprecated classes](#deprecated-classes)
In [WooCommerce Blocks 2.8.0](https://developer.woocommerce.com/2020/06/24/woocommerce-blocks-2-8-release-notes/), we replaced and deprecated some some class names to simplify them, fix inconsistencies, and make it easier to differentiate frontend components from editor components.
@ -97,4 +97,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/designers/theming/class-names-update-330.md
View File

@ -26,4 +26,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/designers/theming/class-names-update-340.md
View File

@ -17,4 +17,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/designers/theming/class-names-update-460.md
View File

@ -20,4 +20,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/designers/theming/filter-blocks.md
View File

@ -37,4 +37,3 @@ 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 -->

5
plugins/woocommerce-blocks/docs/designers/theming/product-grid-270.md
View File

@ -2,8 +2,8 @@
## Table of Contents <!-- omit in toc -->
- [Product images](#product-images)
- [All Products prices](#all-products-prices)
- [Product images](#product-images)
- [All Products prices](#all-products-prices)
In WC Blocks 2.7.0, some of the styles of the product grid blocks were updated to make the experience more consistent. Below, there are CSS code snippets that can undo those changes.
@ -52,4 +52,3 @@ _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 -->

241
plugins/woocommerce-blocks/docs/internal-developers/testing/releases/970.md
View File

@ -23,11 +23,13 @@ The issues are primarily visible with the Twenty Twenty Two theme. However, test
```html
<!-- wp:group {"layout":{"type":"flex","flexWrap":"nowrap"}} -->
<div class="wp-block-group"><!-- wp:woocommerce/breadcrumbs {"textColor":"pale-pink","style":{"elements":{"link":{"color":{"text":"var:preset|color|light-green-cyan"}}}}} /-->
<div class="wp-block-group">
<!-- wp:woocommerce/breadcrumbs {"textColor":"pale-pink","style":{"elements":{"link":{"color":{"text":"var:preset|color|light-green-cyan"}}}}} /-->
<!-- wp:woocommerce/catalog-sorting /-->
<!-- wp:woocommerce/catalog-sorting /-->
<!-- wp:woocommerce/product-results-count {"textColor":"vivid-green-cyan"} /--></div>
<!-- wp:woocommerce/product-results-count {"textColor":"vivid-green-cyan"} /-->
</div>
<!-- /wp:group -->
```
@ -38,40 +40,40 @@ The issues are primarily visible with the Twenty Twenty Two theme. However, test
##### Misaligned Margin
| Before | After |
|-------| ----- |
| Before | After |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img width="1372" alt="CleanShot 2023-02-07 at 07 57 57@2x" src="https://user-images.githubusercontent.com/1429108/217170772-cc744548-3a4e-4dc0-9572-26a7bbbb57e3.png"> | <img width="1359" alt="CleanShot 2023-02-07 at 07 58 58@2x" src="https://user-images.githubusercontent.com/1429108/217170974-ce17659b-95aa-49a6-9211-4b7d26f12cb5.png"> |
##### Breadcrumbs not even displaying for shop page
While it appears okay when editing the Product Catalog template, it is not shown on the frontend for certain themes. It surfaced with Twenty Twenty Two (or derivatives of that theme) for me.
| Before | After |
|-------|--------|
| Before | After |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img width="1362" alt="CleanShot 2023-02-07 at 08 01 49@2x" src="https://user-images.githubusercontent.com/1429108/217171425-48704f27-e0ec-47f7-ab50-b30745a13701.png"> | <img width="1339" alt="CleanShot 2023-02-07 at 08 02 29@2x" src="https://user-images.githubusercontent.com/1429108/217171552-c9f18564-6266-4aa8-92e9-11b0b9eaf05d.png"> |
#### Catalog Sorting Block
| Before | After |
| ------ | ----- |
| Before | After |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img width="1358" alt="CleanShot 2023-02-07 at 08 03 42@2x" src="https://user-images.githubusercontent.com/1429108/217171772-e8cadea6-2398-4a6b-809b-ae8996dd1521.png"> | <img width="1360" alt="CleanShot 2023-02-07 at 08 04 20@2x" src="https://user-images.githubusercontent.com/1429108/217171870-60940c0d-b484-4ea3-a187-040879eb234f.png"> |
#### Product Results Count
| Before | After |
| ------ | ------ |
| <img width="1359" alt="CleanShot 2023-02-07 at 08 05 19@2x" src="https://user-images.githubusercontent.com/1429108/217172067-5304961f-b515-489c-bb2a-232faaec15ce.png"> | <img width="1365" alt="CleanShot 2023-02-07 at 08 05 54@2x" src="https://user-images.githubusercontent.com/1429108/217172178-7b4e1664-1fd0-4a00-99e7-5478db86ba84.png">
| Before | After |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img width="1359" alt="CleanShot 2023-02-07 at 08 05 19@2x" src="https://user-images.githubusercontent.com/1429108/217172067-5304961f-b515-489c-bb2a-232faaec15ce.png"> | <img width="1365" alt="CleanShot 2023-02-07 at 08 05 54@2x" src="https://user-images.githubusercontent.com/1429108/217172178-7b4e1664-1fd0-4a00-99e7-5478db86ba84.png"> |
### Add Product Image Gallery ([8235](https://github.com/woocommerce/woocommerce-blocks/pull/8235))
### Add Product Image Gallery ([8235](https://github.com/woocommerce/woocommerce-blocks/pull/8235))
1. Via Site Editor, edit the Single Product Template.
2. Add the `Product Image Gallery`. Save it.
3. On the frontend side, open a product page, check that the Product Image Gallery is loaded, and show the right images.
4. Check that the block can be added only on the Single Product Template
| Block Details | Preview Editor Side | Frontend |
|---------------|---------------------|-----------|
|![image](https://user-images.githubusercontent.com/4463174/215522884-09459aa4-e51b-4975-9a52-68e4a5a3f769.png)|![image](https://user-images.githubusercontent.com/4463174/218435020-62a15946-2932-40d9-86ec-309bde156c2d.png)|![image](https://user-images.githubusercontent.com/4463174/215523026-a0a35211-ba40-49db-bb88-c773826aa7a1.png)|
| Block Details | Preview Editor Side | Frontend |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| ![image](https://user-images.githubusercontent.com/4463174/215522884-09459aa4-e51b-4975-9a52-68e4a5a3f769.png) | ![image](https://user-images.githubusercontent.com/4463174/218435020-62a15946-2932-40d9-86ec-309bde156c2d.png) | ![image](https://user-images.githubusercontent.com/4463174/215523026-a0a35211-ba40-49db-bb88-c773826aa7a1.png) |
### Add Single Product Details block ([8225](https://github.com/woocommerce/woocommerce-blocks/pull/8225))
@ -85,9 +87,9 @@ While it appears okay when editing the Product Catalog template, it is not shown
8. Save the changes. Access your website and click on a product;
9. Make sure the Single Product Details block appears and contains the product description (Description tab), product attributes (Additional Information tab) and the product reviews (Reviews tab).
| Before | After |
| ------ | ----- |
| <img width="4112" alt="image" src="https://user-images.githubusercontent.com/20469356/215553992-62a8c7e9-af1a-43e4-9845-700a0327d441.png"> | <img width="4118" alt="image" src="https://user-images.githubusercontent.com/20469356/215556988-a14e9fa2-c523-44f6-8bf5-84ba98818a1c.png"> |
| Before | After |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| <img width="4112" alt="image" src="https://user-images.githubusercontent.com/20469356/215553992-62a8c7e9-af1a-43e4-9845-700a0327d441.png"> | <img width="4118" alt="image" src="https://user-images.githubusercontent.com/20469356/215556988-a14e9fa2-c523-44f6-8bf5-84ba98818a1c.png"> |
### Create the Add to Cart Form Block ([8284](https://github.com/woocommerce/woocommerce-blocks/pull/8284))
@ -99,7 +101,6 @@ While it appears okay when editing the Product Catalog template, it is not shown
<img width="414" alt="Screenshot 2023-02-28 at 12 27 55" src="https://user-images.githubusercontent.com/15730971/221840837-689bae27-e952-4a9c-9d55-a3ea10cf4cf2.png">
6. Access a single product page for a Simple product and ensure the content matches the one displayed on the screenshot shared here on this PR.
7. Access a single product page for a Variable product and ensure the content matches the one displayed on the screenshot shared here on this PR.
8. Access a single product page for a Grouped product and ensure the content matches the one displayed on the screenshot shared here on this PR.
@ -155,7 +156,7 @@ The content displayed on the frontend is dynamically changed depending on the pr
Prerequisites:
- Make sure you don't have any "Express Payment Methods".
- Make sure you don't have any "Express Payment Methods".
1. Create a new post
2. Add Cart block
@ -163,10 +164,10 @@ Prerequisites:
- Icon, "Express Checkout" heading and Button looks like on a screenshots attached
- Click button - you should be redirected to `wp-admin/admin.php?page=wc-settings&tab=checkout` page.
| Case | Before | After |
| ------ | ----- | ----- |
| Cart Express Payment | <img width="685" alt="image" src="https://user-images.githubusercontent.com/20098064/218985278-3a5ea338-3992-462f-b9df-2e609b01dd04.png"> | <img width="679" alt="image" src="https://user-images.githubusercontent.com/20098064/218985966-6a2e925c-307c-4941-bf69-7f5deeb3eb84.png"> |
| Checkout Express Payment | <img width="663" alt="image" src="https://user-images.githubusercontent.com/20098064/218985353-44ec9b81-0eec-47e0-9d53-69948732884e.png"> | <img width="660" alt="image" src="https://user-images.githubusercontent.com/20098064/218985769-a9b75e08-0ed9-4730-8481-bce1c42bfb9a.png"> |
| Case | Before | After |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Cart Express Payment | <img width="685" alt="image" src="https://user-images.githubusercontent.com/20098064/218985278-3a5ea338-3992-462f-b9df-2e609b01dd04.png"> | <img width="679" alt="image" src="https://user-images.githubusercontent.com/20098064/218985966-6a2e925c-307c-4941-bf69-7f5deeb3eb84.png"> |
| Checkout Express Payment | <img width="663" alt="image" src="https://user-images.githubusercontent.com/20098064/218985353-44ec9b81-0eec-47e0-9d53-69948732884e.png"> | <img width="660" alt="image" src="https://user-images.githubusercontent.com/20098064/218985769-a9b75e08-0ed9-4730-8481-bce1c42bfb9a.png"> |
### Check for wc-blocks script registration before checking payment method script dependencies ([8428](https://github.com/woocommerce/woocommerce-blocks/pull/8428))
@ -218,16 +219,16 @@ Prerequisites:
2. Add Products block inside Editor
3. Add Product categories and/or Product Tags and/or Keyword to Filters(see screenshot below)
![image](https://user-images.githubusercontent.com/16707866/216572384-91a9802b-e598-4b18-bdbc-158ff0d465f9.png)
![image](https://user-images.githubusercontent.com/16707866/216572384-91a9802b-e598-4b18-bdbc-158ff0d465f9.png)
4. Check the front-end. Only products with added categories, tags, or keywords are showing.
### Move the usage of Notices from @wordpress/components from frontend to editor (Filter by Rating) ([8444](https://github.com/woocommerce/woocommerce-blocks/pull/8444))
1. Make sure you have no products with ratings. You can achieve that by going to `wp-admin/edit.php?post_type=product&page=product-reviews`, mark all the reviews and Bulk Actions -> Move to Trash -> Apply (it can be reverted*)
1. Make sure you have no products with ratings. You can achieve that by going to `wp-admin/edit.php?post_type=product&page=product-reviews`, mark all the reviews and Bulk Actions -> Move to Trash -> Apply (it can be reverted\*)
2. Go to Editor and create new post
3. Add a Filter by Rating block. See the notice is displayed
<img width="969" alt="image" src="https://user-images.githubusercontent.com/20098064/219360523-410ddbb4-19cc-4dad-9c5a-ba9d1e89c094.png">
<img width="969" alt="image" src="https://user-images.githubusercontent.com/20098064/219360523-410ddbb4-19cc-4dad-9c5a-ba9d1e89c094.png">
4. Save the post and go to frontend. Confirm there's no Filter by Rating and no Notice.
Note: to revert moving the reviews to trash go to `http://store.local/wp-admin/edit.php?post_type=product&page=product-reviews&comment_status=trash&paged=1`, mark all the reviews and Bulk Actions -> Restore -> Apply
@ -241,9 +242,9 @@ Note: to revert moving the reviews to trash go to `http://store.local/wp-admin/e
5. Change the text color of the `Catalog Sorting` block.
6. Verify the color is correctly set in the editor and the frontend.
Before | After
--- | ---
<img src="https://user-images.githubusercontent.com/3616980/220139289-8821dbc6-e76b-4aef-8664-dc9055880f5e.png" alt="" width="252" /> | <img src="https://user-images.githubusercontent.com/3616980/220139210-7400a6a7-0066-4d00-a85f-052705091d5a.png" alt="" width="252" />
| Before | After |
| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="https://user-images.githubusercontent.com/3616980/220139289-8821dbc6-e76b-4aef-8664-dc9055880f5e.png" alt="" width="252" /> | <img src="https://user-images.githubusercontent.com/3616980/220139210-7400a6a7-0066-4d00-a85f-052705091d5a.png" alt="" width="252" /> |
### Remove opinionated styles from Button component on block themes that define button styles ([8478](https://github.com/woocommerce/woocommerce-blocks/pull/8478))
@ -265,13 +266,13 @@ Before | After
2.2. Go to the pages created in step 0 and verify the Mini Cart, Cart and Checkout buttons **follow** the theme styles.
Before | After
--- | ---
![imatge](https://user-images.githubusercontent.com/3616980/220114280-77a62b8e-8f52-4789-86e0-021023cd47f7.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220114328-4739053e-b3c1-43c4-a683-5a444eb766ce.png)
| Before | After |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| ![imatge](https://user-images.githubusercontent.com/3616980/220114280-77a62b8e-8f52-4789-86e0-021023cd47f7.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220114328-4739053e-b3c1-43c4-a683-5a444eb766ce.png) |
3. Storefront or another classic theme (test that this PR doesn't introduce any regression):
3.1. Install it from [here](https://wordpress.org/themes/storefront/).
3.2. Go to the pages created in step 0 and verify the Mini Cart, Cart and Checkout buttons **don't follow** the theme styles. Instead, they have opinionated styles.
3.1. Install it from [here](https://wordpress.org/themes/storefront/).
3.2. Go to the pages created in step 0 and verify the Mini Cart, Cart and Checkout buttons **don't follow** the theme styles. Instead, they have opinionated styles.
### Update Product Details block so it inherits more styles from the theme ([8494](https://github.com/woocommerce/woocommerce-blocks/pull/8494))
@ -285,12 +286,12 @@ Repeat these testing steps with at least three themes: [TT2](https://wordpress.o
Note: the screenshots below display the Product Details block in the same template as the Classic Template block. Because of a recent change, adding both to the same template will cause different styling, so you will need to test with only one of them in the same template at the same time.
Theme | Before | After
--- | --- | ---
TT2 | ![imatge](https://user-images.githubusercontent.com/3616980/220280107-bfa5496b-4a25-4097-9c82-06b0adbf9343.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220279896-33e3f81c-5360-4264-ba04-00ef9cac683c.png)
TT3 (Auberginie) | ![imatge](https://user-images.githubusercontent.com/3616980/220279202-67582490-9116-4d16-9a63-9f2cfde32d60.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220279289-614c402e-441d-4848-9d81-757e4f01f549.png)
TT3 (Whisper) | ![imatge](https://user-images.githubusercontent.com/3616980/220278797-3091a82f-1335-4fb2-857b-fa406c5d5267.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220278925-d2dace37-cfe6-4d8e-b004-a2510245a67f.png)
Pixl |![imatge](https://user-images.githubusercontent.com/3616980/220354959-784b5618-eee5-46c6-9c4d-e5655e094b0d.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220354867-363f3c95-b163-4ad5-bd4f-6678b5fa81b0.png)
| Theme | Before | After |
| ---------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| TT2 | ![imatge](https://user-images.githubusercontent.com/3616980/220280107-bfa5496b-4a25-4097-9c82-06b0adbf9343.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220279896-33e3f81c-5360-4264-ba04-00ef9cac683c.png) |
| TT3 (Auberginie) | ![imatge](https://user-images.githubusercontent.com/3616980/220279202-67582490-9116-4d16-9a63-9f2cfde32d60.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220279289-614c402e-441d-4848-9d81-757e4f01f549.png) |
| TT3 (Whisper) | ![imatge](https://user-images.githubusercontent.com/3616980/220278797-3091a82f-1335-4fb2-857b-fa406c5d5267.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220278925-d2dace37-cfe6-4d8e-b004-a2510245a67f.png) |
| Pixl | ![imatge](https://user-images.githubusercontent.com/3616980/220354959-784b5618-eee5-46c6-9c4d-e5655e094b0d.png) | ![imatge](https://user-images.githubusercontent.com/3616980/220354867-363f3c95-b163-4ad5-bd4f-6678b5fa81b0.png) |
**Testing the editor view:**
@ -305,9 +306,9 @@ With [TT2](https://wordpress.org/themes/twentytwentytwo/) and [TT3](https://word
1. Ensure that a block theme is installed, e.g. [TT3](https://wordpress.org/themes/twentytwentythree/) and install [Gutenberg v15.1.0](https://github.com/WordPress/gutenberg/releases/download/v15.1.0/gutenberg.zip)
2. Go to `WP Admin » Appearance » Editor`.
3. Click the blue `Edit` button and then click the `Styles` icon in the upper-right corner.
<img width="273" alt="Screenshot 2023-02-21 at 13 23 00" src="https://user-images.githubusercontent.com/3323310/220263914-44b7013d-c98a-4008-b3ab-a00330d73d22.png">
<img width="273" alt="Screenshot 2023-02-21 at 13 23 00" src="https://user-images.githubusercontent.com/3323310/220263914-44b7013d-c98a-4008-b3ab-a00330d73d22.png">
4. Click on the the `Open Style Book` icon (the one that looks like an eye)
<img width="282" alt="Screenshot 2023-02-21 at 13 23 24" src="https://user-images.githubusercontent.com/3323310/220263978-e0f6e679-a3b4-43be-93a0-c8521b9dea9a.png">
<img width="282" alt="Screenshot 2023-02-21 at 13 23 24" src="https://user-images.githubusercontent.com/3323310/220263978-e0f6e679-a3b4-43be-93a0-c8521b9dea9a.png">
5. Verify that both the Cart and the Checkout blocks are visible.
Kindly note that the Cart and the Checkout blocks will not appear in the blocks sidebar, as they do not support Global Styles yet:
@ -323,22 +324,17 @@ Expected: "Make title a link" in Link Settings is enabled by default
<img width="400" alt="image" src="https://user-images.githubusercontent.com/20098064/220889702-e0e5ae96-ff29-46f7-be60-f46c0b24e278.png">
| Before | After |
| ------ | ----- |
| <img width="683" alt="image" src="https://user-images.githubusercontent.com/20098064/220889529-1d791b2d-7648-471d-a598-2f0a0878ff93.png"> | <img width="689" alt="image" src="https://user-images.githubusercontent.com/20098064/220889702-e0e5ae96-ff29-46f7-be60-f46c0b24e278.png"> |
| Before | After |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| <img width="683" alt="image" src="https://user-images.githubusercontent.com/20098064/220889529-1d791b2d-7648-471d-a598-2f0a0878ff93.png"> | <img width="689" alt="image" src="https://user-images.githubusercontent.com/20098064/220889702-e0e5ae96-ff29-46f7-be60-f46c0b24e278.png"> |
### Fix noticeContext declaration in the Shipping calculator ([8495](https://github.com/woocommerce/woocommerce-blocks/pull/8495))
1.Add a product to the cart.
2. Go to the Cart block page.
3. Open the shipping calculator.
4. Enter any address with an invalid zip code.
5. Confirm the error notice is getting displayed in the calculator.
6. Confirm there are no errors in the browser console.
1.Add a product to the cart. 2. Go to the Cart block page. 3. Open the shipping calculator. 4. Enter any address with an invalid zip code. 5. Confirm the error notice is getting displayed in the calculator. 6. Confirm there are no errors in the browser console.
| Before | After |
| ------ | ----- |
| <img width="1460" alt="image" src="https://user-images.githubusercontent.com/11503784/220375868-807057f0-dd30-4a4b-9912-e45e51f91f34.png"> |<img width="772" alt="image" src="https://user-images.githubusercontent.com/11503784/220375271-3f6b076b-eef1-4e07-96ec-e0d116d289dd.png">|
| Before | After |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| <img width="1460" alt="image" src="https://user-images.githubusercontent.com/11503784/220375868-807057f0-dd30-4a4b-9912-e45e51f91f34.png"> | <img width="772" alt="image" src="https://user-images.githubusercontent.com/11503784/220375271-3f6b076b-eef1-4e07-96ec-e0d116d289dd.png"> |
### Fix Product Price and Product Rating alignment ([8526](https://github.com/woocommerce/woocommerce-blocks/pull/8526))
@ -431,7 +427,7 @@ Expected: "Make title a link" in Link Settings is enabled by default
1. Install Stripe, enable it, and checkout (save your card to the account)
2. Checkout another order but this time confirm the method you saved in step 1 is displayed as an option.
3. Go to Payment settings and uncheck the "enabled" checkbox for stripe. Do not disable the actual plugin.
3. Go to Payment settings and uncheck the "enabled" checkbox for stripe. Do not disable the actual plugin.
4. Checkout again. Confirm the saved card is not visible.
### Disable compatibility layer via hook ([8550](https://github.com/woocommerce/woocommerce-blocks/pull/8550))
@ -447,10 +443,10 @@ Expected: "Make title a link" in Link Settings is enabled by default
##### Prerequisites
- WordPress: >=6.1
- Make sure Single Product template is cleared out to the default state. To achieve that:
1. Go to (`/wp-admin/site-editor.php?postType=wp_template`)
2. Click three dots next to template and click "Clear customizations"
- WordPress: >=6.1
- Make sure Single Product template is cleared out to the default state. To achieve that:
1. Go to (`/wp-admin/site-editor.php?postType=wp_template`)
2. Click three dots next to template and click "Clear customizations"
##### Steps
@ -469,9 +465,9 @@ Repeat for Product Catalog, Products by Category and Product Search Results tem
3. Set a custom `Size` and `Appearance` for the Product Price block.
4. Notice that the change displays fine in the editor and frontend both for regular and sale prices.
| Before | After |
| ------ | ----- |
|![before-4](https://user-images.githubusercontent.com/905781/217533868-20817df4-daec-438d-adf2-9e687fc0f047.jpg)|![after-4](https://user-images.githubusercontent.com/905781/217533882-a23aba83-7a3e-4853-bc89-7ec4a685f444.jpg)|
| Before | After |
| ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| ![before-4](https://user-images.githubusercontent.com/905781/217533868-20817df4-daec-438d-adf2-9e687fc0f047.jpg) | ![after-4](https://user-images.githubusercontent.com/905781/217533882-a23aba83-7a3e-4853-bc89-7ec4a685f444.jpg) |
## Experimental
@ -499,10 +495,10 @@ Make sure Product Catalog and Products by Category templates are cleared out to
##### Prerequisites
- WordPress: >=6.1
- Make sure Product Catalog/Products by Category/Products by Attribute/Products by Tag/Product Search Results templates are cleared out to the default state. To achieve that:
1. Go to (`/wp-admin/site-editor.php?postType=wp_template`)
2. Click three dots next to template and click "Clear customizations"
- WordPress: >=6.1
- Make sure Product Catalog/Products by Category/Products by Attribute/Products by Tag/Product Search Results templates are cleared out to the default state. To achieve that:
1. Go to (`/wp-admin/site-editor.php?postType=wp_template`)
2. Click three dots next to template and click "Clear customizations"
##### Steps
@ -515,36 +511,35 @@ Make sure Product Catalog and Products by Category templates are cleared out to
WooCommerce Product Grid Block is replaced with blocks:
- Products (Beta)
- Store Breadcrumbs (video was recorded before Breadcrumbs were added)
- Archive Title
- Term Description (only in _Products By *_ templates)
- Store Notices
- Row
- Product Results Count
- Catalog Sorting
- Product Template
- Pagination
- No Results
- Products (Beta)
- Store Breadcrumbs (video was recorded before Breadcrumbs were added)
- Archive Title
- Term Description (only in _Products By \*_ templates)
- Store Notices
- Row
- Product Results Count
- Catalog Sorting
- Product Template
- Pagination
- No Results
<img width="377" alt="image" src="https://user-images.githubusercontent.com/20098064/220606297-868820be-7d91-4d44-b359-22e988ec9e26.png">
5. Go to "Products (beta)" block settings
6. Make sure "Inherit query from template" is ENABLED! It should be by default.
7. Save the template
9. Go to frontend (`/shop`) and check it the blocks are displayed correctly. You should expect the view like this:
8. Go to frontend (`/shop`) and check it the blocks are displayed correctly. You should expect the view like this:
<img width="1791" alt="image" src="https://user-images.githubusercontent.com/20098064/216027859-eab87a5a-b0e9-4312-bcd0-a0e36a73d6f5.png">
- Check the Product Results Count displays proper numbers, e.g. go to the page 2 (it should say "Showing 17–17 of 17 results" if you're using "standard" products set).
- Check the Catalog Sorting sorts the products correctly, e.g. by price.
- Check the Product Results Count displays proper numbers, e.g. go to the page 2 (it should say "Showing 17–17 of 17 results" if you're using "standard" products set).
- Check the Catalog Sorting sorts the products correctly, e.g. by price.
Repeat the steps above for:
- Products by Category (to check frontend, go to `/product-category/clothing/`)
- Expected view contains Breadcrums
<img width="1698" alt="image" src="https://user-images.githubusercontent.com/20098064/216028890-a36151d9-f61d-4d28-9254-f99fe841db21.png">
- Products by Category (to check frontend, go to `/product-category/clothing/`)
- Expected view contains Breadcrums
<img width="1698" alt="image" src="https://user-images.githubusercontent.com/20098064/216028890-a36151d9-f61d-4d28-9254-f99fe841db21.png">
---
@ -552,10 +547,10 @@ Repeat the steps above for:
##### Prerequisites
- WordPress: >=6.1
- Make sure Product Search Results template is cleared out to the default state. To achieve that:
1. Go to (`/wp-admin/site-editor.php?postType=wp_template`)
2. Click three dots next to template and click "Clear customizations"
- WordPress: >=6.1
- Make sure Product Search Results template is cleared out to the default state. To achieve that:
1. Go to (`/wp-admin/site-editor.php?postType=wp_template`)
2. Click three dots next to template and click "Clear customizations"
##### Steps
@ -563,22 +558,12 @@ Repeat the steps above for:
2. Check that placeholder description says "This block serves as a placeholder for your WooCommerce Product Search Results Block. We recommend upgrading to the Products block for more features to edit your products visually. Don't worry, you can always revert back."
3. Open List View of the blocks
4. Click "Upgrade to Products block" button
<img width="902" alt="Screen Shot 2023-01-25 at 11 27 32 AM" src="https://user-images.githubusercontent.com/20098064/214540490-839d351d-c837-4db5-b991-f8293b8a924b.png">
<img width="902" alt="Screen Shot 2023-01-25 at 11 27 32 AM" src="https://user-images.githubusercontent.com/20098064/214540490-839d351d-c837-4db5-b991-f8293b8a924b.png">
WooCommerce Product Grid Block is replaced with blocks:
- Products (Beta)
- Search Results Title
- Store Notices
- Row
- Product Results Count
- Catalog Sorting
- Product Template
- Pagination
- No Results
- Paragraph (content: "No products were found matching your selection.")
- Product Search
<img width="353" alt="image" src="https://user-images.githubusercontent.com/20098064/220606824-b69d0ed1-d7d0-4ed9-8d6a-33a4d2279390.png">
- Products (Beta) - Search Results Title - Store Notices - Row - Product Results Count - Catalog Sorting - Product Template - Pagination - No Results - Paragraph (content: "No products were found matching your selection.") - Product Search
<img width="353" alt="image" src="https://user-images.githubusercontent.com/20098064/220606824-b69d0ed1-d7d0-4ed9-8d6a-33a4d2279390.png">
5. Go to "Products (beta)" block settings
6. Make sure "Inherit query from template" is ENABLED! It should be by default.
@ -587,9 +572,9 @@ WooCommerce Product Grid Block is replaced with blocks:
9. Go to frontend (e.g. `/shop`)
10. Use Product Search in the template
11. Enter a phrase that would cover some product names like: `t shirt` or `beanie`. You should expect the product list
<img width="1689" alt="image" src="https://user-images.githubusercontent.com/20098064/216032029-c7b53c21-0f90-4eeb-8785-f91e4847ed84.png">
<img width="1689" alt="image" src="https://user-images.githubusercontent.com/20098064/216032029-c7b53c21-0f90-4eeb-8785-f91e4847ed84.png">
12. Enter a random phrase like `blah blah` or `cars`. You should expect the "No results" page with information and Product Search bar:
<img width="1688" alt="image" src="https://user-images.githubusercontent.com/20098064/216032232-787b4cd9-8a8e-4854-9983-8e31d6f5e57a.png">
<img width="1688" alt="image" src="https://user-images.githubusercontent.com/20098064/216032232-787b4cd9-8a8e-4854-9983-8e31d6f5e57a.png">
---
@ -607,7 +592,7 @@ Make sure Product Catalog template is cleared out to the default state. To achie
1. Enter the Product Catalog template
2. Change the `align` setting of the Classic Template block to either "None" or "Full width"
<img width="509" alt="image" src="https://user-images.githubusercontent.com/20098064/216032869-0dc71774-7a58-4e88-87cb-aa8be28f780a.png">
<img width="509" alt="image" src="https://user-images.githubusercontent.com/20098064/216032869-0dc71774-7a58-4e88-87cb-aa8be28f780a.png">
3. Click "Upgrade to Products block" button: Blocks keeps the same `align` setting in Editor:
- Store Breadcrumbs
- Archive Title
@ -619,27 +604,27 @@ Make sure Product Catalog template is cleared out to the default state. To achie
#### Product Archive - side by side comparison (editor)
| Classic Template | Blockified Template |
|------------------|---------------------|
|. <img width="1452" alt="image" src="https://user-images.githubusercontent.com/20098064/214842888-86fdf879-1a47-4c4c-882a-df28101a5da6.png"> | <img width="1407" alt="image" src="https://user-images.githubusercontent.com/20098064/214842960-4ec491b4-4f16-4b64-a234-ecb33501d061.png"> |
| Classic Template | Blockified Template |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| . <img width="1452" alt="image" src="https://user-images.githubusercontent.com/20098064/214842888-86fdf879-1a47-4c4c-882a-df28101a5da6.png"> | <img width="1407" alt="image" src="https://user-images.githubusercontent.com/20098064/214842960-4ec491b4-4f16-4b64-a234-ecb33501d061.png"> |
#### Product Archive - side by side comparison (frontend)
| Classic Template | Blockified Template |
|------------------|---------------------|
|. <img width="1755" alt="image" src="https://user-images.githubusercontent.com/20098064/214839214-5939fdc6-282d-4fbd-8255-a37d7978f635.png"> | <img width="1989" alt="image" src="https://user-images.githubusercontent.com/20098064/214839357-1e504761-c980-4a4e-843d-414af8c0c1de.png"> |
| Classic Template | Blockified Template |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| . <img width="1755" alt="image" src="https://user-images.githubusercontent.com/20098064/214839214-5939fdc6-282d-4fbd-8255-a37d7978f635.png"> | <img width="1989" alt="image" src="https://user-images.githubusercontent.com/20098064/214839357-1e504761-c980-4a4e-843d-414af8c0c1de.png"> |
#### Product Archive - copy update (editor)
| Before | After |
|------------------|---------------------|
|.<img width="1071" alt="image" src="https://user-images.githubusercontent.com/20098064/214840855-2b708b27-b38d-4d45-93d6-a59986bdcad3.png"> | <img width="1106" alt="image" src="https://user-images.githubusercontent.com/20098064/214840974-1abee34c-6f6f-4474-a423-0d8d12ca5896.png"> |
| Before | After |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| .<img width="1071" alt="image" src="https://user-images.githubusercontent.com/20098064/214840855-2b708b27-b38d-4d45-93d6-a59986bdcad3.png"> | <img width="1106" alt="image" src="https://user-images.githubusercontent.com/20098064/214840974-1abee34c-6f6f-4474-a423-0d8d12ca5896.png"> |
#### Single product - copy update (editor)
| Before | After |
|------------------|---------------------|
|.<img width="1078" alt="image" src="https://user-images.githubusercontent.com/20098064/214840396-ea8a3a0d-2aeb-4a01-9b87-3e2459a9d406.png"> | <img width="1055" alt="image" src="https://user-images.githubusercontent.com/20098064/214840017-dceb997a-0d03-448c-8f37-23a11f4e7b6a.png"> |
| Before | After |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| .<img width="1078" alt="image" src="https://user-images.githubusercontent.com/20098064/214840396-ea8a3a0d-2aeb-4a01-9b87-3e2459a9d406.png"> | <img width="1055" alt="image" src="https://user-images.githubusercontent.com/20098064/214840017-dceb997a-0d03-448c-8f37-23a11f4e7b6a.png"> |
Video presents the replacement of a Classic Template on two templates: Product Catalog and Products by Category
@ -654,24 +639,24 @@ Video presents the replacement of a Classic Template on two templates: Product C
5. Remove "Add to Cart Button" block
6. Add "Add to Cart" block - THESE ARE TWO SEPARATE BLOCKS. IT'S ABOUT "ADD TO CART" BLOCK!
7. By default the "Display form elements" toggle should be disabled
**Expected**: Button looks like on a pictures above
**Expected**: Button looks like on a pictures above
8. Save the changes and check the frontend as well
9. Enter the edit mode of "Add to Cart" button (there's a [bug that block cannot be clicked](https://github.com/woocommerce/woocommerce-blocks/issues/8439). To enter the edit mode, please open a "list view" of blocks and choose "Add to Cart" from there)
10. Enable "Display form elements" toggle
**Expected**: Button looks like on a pictures above (while it changes to form for other types of products: simple, variable)
**Expected**: Button looks like on a pictures above (while it changes to form for other types of products: simple, variable)
11. Save the changes and check the frontend as well
#### Editor - Grouped product is the middle one on each image. Other products are included for comparison
| Case | Before | After |
| ------ | ----- |----- |
| Display form elements: disabled | <img width="620" alt="image" src="https://user-images.githubusercontent.com/20098064/219035374-59f7e3d5-cf88-4450-8052-b1e7bcde275b.png"> | <img width="637" alt="image" src="https://user-images.githubusercontent.com/20098064/219033902-bc991786-e9cc-41c6-9ae8-1f33cda4378c.png"> |
| Display form elements: enabled | <img width="630" alt="image" src="https://user-images.githubusercontent.com/20098064/219035240-8e943b7d-5422-4acf-9cda-f610be2f3fb8.png"> | <img width="628" alt="image" src="https://user-images.githubusercontent.com/20098064/219034539-606de553-f664-4e45-b252-a903001a455b.png"> |
| Case | Before | After |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Display form elements: disabled | <img width="620" alt="image" src="https://user-images.githubusercontent.com/20098064/219035374-59f7e3d5-cf88-4450-8052-b1e7bcde275b.png"> | <img width="637" alt="image" src="https://user-images.githubusercontent.com/20098064/219033902-bc991786-e9cc-41c6-9ae8-1f33cda4378c.png"> |
| Display form elements: enabled | <img width="630" alt="image" src="https://user-images.githubusercontent.com/20098064/219035240-8e943b7d-5422-4acf-9cda-f610be2f3fb8.png"> | <img width="628" alt="image" src="https://user-images.githubusercontent.com/20098064/219034539-606de553-f664-4e45-b252-a903001a455b.png"> |
#### Frontend - Grouped product is the middle one on each image. Other products are included for comparison
| Case | Before | After |
| ------ | ----- |----- |
| Display form elements: disabled | <img width="671" alt="image" src="https://user-images.githubusercontent.com/20098064/219035426-a0032999-2d10-4389-9945-0ba2fb7accc7.png"> | <img width="658" alt="image" src="https://user-images.githubusercontent.com/20098064/219034371-c2ab137a-1c38-4907-91c3-a5c69db8fed3.png"> |
| Display form elements: enabled | <img width="665" alt="image" src="https://user-images.githubusercontent.com/20098064/219035271-97621392-9299-4cde-9628-fa750f805faf.png"> | <img width="659" alt="image" src="https://user-images.githubusercontent.com/20098064/219034622-44db616a-5a7e-4359-bac7-537c404f1add.png"> |
| Case | Before | After |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Display form elements: disabled | <img width="671" alt="image" src="https://user-images.githubusercontent.com/20098064/219035426-a0032999-2d10-4389-9945-0ba2fb7accc7.png"> | <img width="658" alt="image" src="https://user-images.githubusercontent.com/20098064/219034371-c2ab137a-1c38-4907-91c3-a5c69db8fed3.png"> |
| Display form elements: enabled | <img width="665" alt="image" src="https://user-images.githubusercontent.com/20098064/219035271-97621392-9299-4cde-9628-fa750f805faf.png"> | <img width="659" alt="image" src="https://user-images.githubusercontent.com/20098064/219034622-44db616a-5a7e-4359-bac7-537c404f1add.png"> |

3
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/README.md
View File

@ -39,7 +39,7 @@ In addition to the reference material below, [please see the `block-checkout` pa
| Document | Description |
| ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| [How the Checkout Block processes an order](./checkout-block/how-checkout-processes-an-order.md) | The detailed inner workings of the Checkout Flow. |
| [How the Checkout Block processes an order](./checkout-block/how-checkout-processes-an-order.md) | The detailed inner workings of the Checkout Flow. |
| [IntegrationInterface](./checkout-block/integration-interface.md) | The `IntegrationInterface` class and how to use it to register scripts, styles, and data with WooCommerce Blocks. |
| [Available Filters](./checkout-block/available-filters.md) | All about the filters that you may use to change values of certain elements of WooCommerce Blocks. |
| [Slots and Fills](./checkout-block/slot-fills.md) | Explains Slot Fills and how to use them to render your own components in Cart and Checkout. |
@ -56,4 +56,3 @@ 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 -->

6
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/checkout-block/available-filters.md
View File

@ -128,9 +128,9 @@ By using the `additionalCartCheckoutInnerBlockTypes` filter it is possible to ad
This filter is called once for each inner block area, so it is possible to be very granular when determining what blocks can be added where. See the [Allowing blocks in specific areas in the Cart and Checkout blocks.](#allowing-blocks-in-specific-areas-in-the-cart-and-checkout-blocks) example for more information.
| Filter name | Description | Return type |
| ------------------- | --------------------------------------- | ------------- |
| `additionalCartCheckoutInnerBlockTypes` | The new array of allowed block types. | `string[]` |
| Filter name | Description | Return type |
| --------------------------------------- | ------------------------------------- | ----------- |
| `additionalCartCheckoutInnerBlockTypes` | The new array of allowed block types. | `string[]` |
## Examples

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/checkout-block/available-slot-fills.md
View File

@ -101,4 +101,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/checkout-block/dom-events.md
View File

@ -50,4 +50,3 @@ _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 -->

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/checkout-block/how-checkout-processes-an-order.md
View File

@ -145,4 +145,3 @@ 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 -->

21
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/checkout-block/integration-interface.md
View File

@ -2,16 +2,16 @@
## Table of Contents <!-- omit in toc -->
- [The problem](#the-problem)
- [The solution](#the-solution)
- [`IntegrationInterface` methods](#integrationinterface-methods)
- [`get_name()`](#get_name)
- [`initialize()`](#initialize)
- [`get_script_handles()`](#get_script_handles)
- [`get_editor_script_handles()`](#get_editor_script_handles)
- [`get_script_data()`](#get_script_data)
- [Usage example](#usage-example)
- [Getting data added in `get_script_data`](#getting-data-added-in-get_script_data)
- [The problem](#the-problem)
- [The solution](#the-solution)
- [`IntegrationInterface` methods](#integrationinterface-methods)
- [`get_name()`](#get_name)
- [`initialize()`](#initialize)
- [`get_script_handles()`](#get_script_handles)
- [`get_editor_script_handles()`](#get_editor_script_handles)
- [`get_script_data()`](#get_script_data)
- [Usage example](#usage-example)
- [Getting data added in `get_script_data`](#getting-data-added-in-get_script_data)
## The problem
@ -213,4 +213,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/checkout-block/slot-fills.md
View File

@ -72,4 +72,3 @@ 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 -->

11
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/checkout-payment-methods/checkout-flow-and-events.md
View File

@ -11,14 +11,3 @@ 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 -->
<!-- FEEDBACK -->
---
[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/third-party-developers/extensibility/checkout-payment-methods/checkout-flow-and-events.md)
<!-- /FEEDBACK -->

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/checkout-payment-methods/filtering-payment-methods.md
View File

@ -174,4 +174,3 @@ 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 -->

3
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/checkout-payment-methods/payment-method-integration.md
View File

@ -169,7 +169,7 @@ A big part of the payment method integration is the interface that is exposed fo
| `checkoutStatus` | Object | The current checkout status exposed as various boolean state. | `isCalculating`, `isComplete`, `isIdle`, `isProcessing` |
| `components` | Object | It exposes React components that can be implemented by your payment method for various common interface elements used by payment methods. | <ul><li>`ValidationInputError`: a container for holding validation errors which typically you'll include after any inputs</li><li>[`PaymentMethodLabel`](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/e089ae17043fa525e8397d605f0f470959f2ae95/assets/js/payment-method-extensions/payment-methods/paypal/index.js#L37-L40): use this component for the payment method label, including an optional icon</li><li>`PaymentMethodIcons`: a React component used for displaying payment method icons</li><li>`LoadingMask`: a wrapper component that handles displaying a loading state when the isLoading prop is true. Exposes the [LoadingMask component](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/c9074a4941919987dbad16a80f358b960336a09d/assets/js/base/components/loading-mask/index.js) </li></ul> |
| `emitResponse` | Object | Contains some constants that can be helpful when using the event emitter. Read the _[Emitting Events](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/e267cd96a4329a4eeef816b2ef627e113ebb72a5/docs/extensibility/checkout-flow-and-events.md#emitting-events)_ section for more details. | <ul><li>`noticeContexts`: This is an object containing properties referencing areas where notices can be targeted in the checkout. The object has the following properties: <ul><li>`PAYMENTS`: This is a reference to the notice area in the payment methods step.</li><li>`EXPRESS_PAYMENTS`: This is a reference to the notice area in the express payment methods step.</li></ul></li><li>`responseTypes`: This is an object containing properties referencing the various response types that can be returned by observers for some event emitters. It makes it easier for autocompleting the types and avoiding typos due to human error. The types are `SUCCESS`, `FAIL`, `ERROR`. The values for these types also correspond to the [payment status types](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/34e17c3622637dbe8b02fac47b5c9b9ebf9e3596/src/Payments/PaymentResult.php#L21) from the [checkout endpoint response from the server](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/34e17c3622637dbe8b02fac47b5c9b9ebf9e3596/src/RestApi/StoreApi/Schemas/CheckoutSchema.php#L103-L113).</li></ul> |
| `eventRegistration` | object | Contains all the checkout event emitter registration functions. These are functions the payment method can register observers on to interact with various points in the checkout flow (see [this doc](./checkout-flow-and-events.md) for more info). | `onCheckoutValidation`, `onCheckoutSuccess`, `onCheckoutFail`, `onPaymentProcessing`, `onShippingRateSuccess`, `onShippingRateFail`, `onShippingRateSelectSuccess`, `onShippingRateSelectFail` |
| `eventRegistration` | object | Contains all the checkout event emitter registration functions. These are functions the payment method can register observers on to interact with various points in the checkout flow (see [this doc](./checkout-flow-and-events.md) for more info). | `onCheckoutValidation`, `onCheckoutSuccess`, `onCheckoutFail`, `onPaymentProcessing`, `onShippingRateSuccess`, `onShippingRateFail`, `onShippingRateSelectSuccess`, `onShippingRateSelectFail` |
| `onClick` | Function | **Provided to express payment methods** that should be triggered when the payment method button is clicked (which will signal to checkout the payment method has taken over payment processing) | - |
| `onClose` | Function | **Provided to express payment methods** that should be triggered when the express payment method modal closes and control is returned to checkout. | - |
| `onSubmit` | Function | Submits the checkout and begins processing | - |
@ -265,4 +265,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/data-store/README.md
View File

@ -16,4 +16,3 @@
🐞 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 -->

195
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/data-store/cart.md
View File

@ -32,22 +32,22 @@ Returns the Cart data from the state.
`object` - The current cart data. This will be an object with the following keys:
- `coupons` - array containing the coupon items in the cart.
- `shippingRates` - array containing the cart shipping rates (see `getShippingRates` selector).
- `shippingAddress` - object containing the shipping address (see `getCustomerData` selector).
- `billingAddress` - object containing the billing address.
- `items` - array containing the cart items.
- `itemsCount` - number containing total number of items in the cart.
- `itemsWeight` - number containing the total weight of items in the cart.
- `crossSells` - array containing the cross sells.
- `needsPayment` - boolean indicating if the cart needs payment.
- `needsShipping`- boolean indicating if the cart needs shipping.
- `hasCalculatedShipping`- boolean indicating if the cart has calculated shipping.
- `fees`- array containing the cart fees.
- `totals`- object containing the cart totals (see `getCartTotals` selector).
- `errors`- array containing the cart errors (see `getCartErrors` selector).
- `paymentRequirements`- object containing the payment requirements for the cart.
- `extensions`- object containing the extensions data.
- `coupons` - array containing the coupon items in the cart.
- `shippingRates` - array containing the cart shipping rates (see `getShippingRates` selector).
- `shippingAddress` - object containing the shipping address (see `getCustomerData` selector).
- `billingAddress` - object containing the billing address.
- `items` - array containing the cart items.
- `itemsCount` - number containing total number of items in the cart.
- `itemsWeight` - number containing the total weight of items in the cart.
- `crossSells` - array containing the cross sells.
- `needsPayment` - boolean indicating if the cart needs payment.
- `needsShipping`- boolean indicating if the cart needs shipping.
- `hasCalculatedShipping`- boolean indicating if the cart has calculated shipping.
- `fees`- array containing the cart fees.
- `totals`- object containing the cart totals (see `getCartTotals` selector).
- `errors`- array containing the cart errors (see `getCartErrors` selector).
- `paymentRequirements`- object containing the payment requirements for the cart.
- `extensions`- object containing the extensions data.
#### _Example_
@ -62,22 +62,19 @@ Returns the shipping and billing address from the state.
#### _Returns_
`object`- The current shipping and billing address. This will be an object with the following keys:
- `shippingAddress`- Object containing the shipping address. This will be an object with the following
keys:
- `first_name`- string containing the first name.
- `last_name`- string containing the last name.
- `company`- string containing the company.
- `address_1`- string containing the address line 1.
- `address_2`- string containing the address line 2.
- `city`- string containing the city.
- `state`- string containing the state.
- `postcode`- string containing the postcode.
- `country`- string containing the country.
- `billingAddress`- Object containing the billing address (same keys as shipping address).
`object` The current shipping and billing address. This will be an object with the following keys:
- `shippingAddress`- Object containing the shipping address. This will be an object with the following keys:
- `first_name` string containing the first name.
- `last_name` string containing the last name.
- `company` string containing the company.
- `address_1` string containing the address line 1.
- `address_2` string containing the address line 2.
- `city` string containing the city.
- `state` string containing the state.
- `postcode` string containing the postcode.
- `country` string containing the country.
- `billingAddress` Object containing the billing address (same keys as shipping address).
#### _Example_
@ -139,25 +136,24 @@ Returns the cart totals from state.
`object`- The current cart totals. This will be an object with the following keys:
- `total_items`- string containing the sum total of items in the cart without discount, tax or shipping.
- `total_items_tax`- string containing the total tax on all items before discount.
- `total_fees`- string containing the total transaction fees.
- `total_fees_tax`- string containing the tax on the total transaction fees.
- `total_discount`- string containing the total discount applied to the cart.
- `total_discount_tax`- string containing the tax applied to the total discount amount.
- `total_shipping`- string containing the total shipping cost.
- `total_shipping_tax`- string containing the tax applied to the total shipping cost.
- `total_tax`- string containing the total tax applied to the cart.
- `total_price`- string containing the total price of the cart including discount, tax or shipping.
- `tax_lines`- array of object containing the tax lines: `name`, `price`, and `rate`.
- `currency_code`- string containing the currency code for the cart.
- `currency_symbol`- string containing the currency symbol for the cart.
- `currency_minor_unit`- integer containing the currency minor unit for the cart.
- `currency_decimal_separator`- string containing the currency decimal separator for the cart.
- `currency_thousand_separator`- string containing the currency thousand separator for the cart.
- `currency_prefix`- string containing the currency prefix for the cart.
- `currency_suffix`- string containing the currency suffix for the cart.
- `total_items`- string containing the sum total of items in the cart without discount, tax or shipping.
- `total_items_tax`- string containing the total tax on all items before discount.
- `total_fees`- string containing the total transaction fees.
- `total_fees_tax`- string containing the tax on the total transaction fees.
- `total_discount`- string containing the total discount applied to the cart.
- `total_discount_tax`- string containing the tax applied to the total discount amount.
- `total_shipping`- string containing the total shipping cost.
- `total_shipping_tax`- string containing the tax applied to the total shipping cost.
- `total_tax`- string containing the total tax applied to the cart.
- `total_price`- string containing the total price of the cart including discount, tax or shipping.
- `tax_lines`- array of object containing the tax lines: `name`, `price`, and `rate`.
- `currency_code`- string containing the currency code for the cart.
- `currency_symbol`- string containing the currency symbol for the cart.
- `currency_minor_unit`- integer containing the currency minor unit for the cart.
- `currency_decimal_separator`- string containing the currency decimal separator for the cart.
- `currency_thousand_separator`- string containing the currency thousand separator for the cart.
- `currency_prefix`- string containing the currency prefix for the cart.
- `currency_suffix`- string containing the currency suffix for the cart.
#### _Example_
@ -174,11 +170,11 @@ Returns the cart meta from state.
`object`- The current cart meta. This will be an object with the following keys:
- `updatingCustomerData`- boolean indicating if the customer data is being updated.
- `updatingSelectedRate`- boolean indicating if the selected rate is being updated.
- `isCartDataStale`- boolean indicating if the cart data is stale.
- `applyingCoupon`- string containing the coupon code being applied.
- `removingCoupon`- string containing the coupon code being removed.
- `updatingCustomerData`- boolean indicating if the customer data is being updated.
- `updatingSelectedRate`- boolean indicating if the selected rate is being updated.
- `isCartDataStale`- boolean indicating if the cart data is stale.
- `applyingCoupon`- string containing the coupon code being applied.
- `removingCoupon`- string containing the coupon code being removed.
#### _Example_
@ -283,52 +279,52 @@ Returns a cart item from the state.
#### _Parameters_
- cartItemKey `string` - The cart item key.
- cartItemKey `string` - The cart item key.
#### _Returns_
`object`- The cart item. This will be an object with the following keys:
- `key`- string containing the cart item key.
- `id`- number containing the cart item id.
- `catalog_visibility`- string containing the catalog visibility.
- `quantity_limits`- object containing the quantity limits.
- `name`- string containing the cart item name.
- `summary`- string containing the cart item summary.
- `short_description`- string containing the cart item short description.
- `description`- string containing the cart item description.
- `sku`- string containing the cart item sku.
- `low_stock_remaining`- null or number containing the low stock remaining.
- `backorders_allowed`- boolean indicating if backorders are allowed.
- `show_backorder_badge`- boolean indicating if the backorder badge should be shown.
- `sold_individually`- boolean indicating if the item is sold individually.
- `permalink`- string containing the cart item permalink.
- `images`- array containing the cart item images.
- `variation`- array containing the cart item variation.
- `prices`- object containing the cart item prices. The keys for the object will be as follows:
- `currency_code`- string containing the currency code.
- `currency_symbol`- string containing the currency symbol.
- `currency_minor_unit`- number containing the currency minor unit.
- `currency_decimal_separator`- string containing the currency decimal separator.
- `currency_thousand_separator`- string containing the currency thousand separator.
- `currency_prefix`- string containing the currency prefix.
- `currency_suffix`- string containing the currency suffix.
- `price`- string containing the cart item price.
- `regular_price`- string containing the cart item regular price.
- `sale_price`- string containing the cart item sale price.
- `price_range`- string containing the cart item price range.
- `totals`- object containing the cart item totals. They keys for the object will be as follows:
- `currency_code`- string containing the currency code.
- `currency_symbol`- string containing the currency symbol.
- `currency_minor_unit`- number containing the currency minor unit.
- `currency_decimal_separator`- string containing the currency decimal separator.
- `currency_thousand_separator`- string containing the currency thousand separator.
- `currency_prefix`- string containing the currency prefix.
- `currency_suffix`- string containing the currency suffix.
- `line_subtotal`- string containing the cart item line subtotal.
- `line_subtotal_tax`- string containing the cart item line subtotal tax.
- `line_total`- string containing the cart item line total.
- `line_total_tax`- string containing the cart item line total tax.
- `key`- string containing the cart item key.
- `id`- number containing the cart item id.
- `catalog_visibility`- string containing the catalog visibility.
- `quantity_limits`- object containing the quantity limits.
- `name`- string containing the cart item name.
- `summary`- string containing the cart item summary.
- `short_description`- string containing the cart item short description.
- `description`- string containing the cart item description.
- `sku`- string containing the cart item sku.
- `low_stock_remaining`- null or number containing the low stock remaining.
- `backorders_allowed`- boolean indicating if backorders are allowed.
- `show_backorder_badge`- boolean indicating if the backorder badge should be shown.
- `sold_individually`- boolean indicating if the item is sold individually.
- `permalink`- string containing the cart item permalink.
- `images`- array containing the cart item images.
- `variation`- array containing the cart item variation.
- `prices`- object containing the cart item prices. The keys for the object will be as follows:
- `currency_code`- string containing the currency code.
- `currency_symbol`- string containing the currency symbol.
- `currency_minor_unit`- number containing the currency minor unit.
- `currency_decimal_separator`- string containing the currency decimal separator.
- `currency_thousand_separator`- string containing the currency thousand separator.
- `currency_prefix`- string containing the currency prefix.
- `currency_suffix`- string containing the currency suffix.
- `price`- string containing the cart item price.
- `regular_price`- string containing the cart item regular price.
- `sale_price`- string containing the cart item sale price.
- `price_range`- string containing the cart item price range.
- `totals`- object containing the cart item totals. They keys for the object will be as follows:
- `currency_code`- string containing the currency code.
- `currency_symbol`- string containing the currency symbol.
- `currency_minor_unit`- number containing the currency minor unit.
- `currency_decimal_separator`- string containing the currency decimal separator.
- `currency_thousand_separator`- string containing the currency thousand separator.
- `currency_prefix`- string containing the currency prefix.
- `currency_suffix`- string containing the currency suffix.
- `line_subtotal`- string containing the cart item line subtotal.
- `line_subtotal_tax`- string containing the cart item line subtotal tax.
- `line_total`- string containing the cart item line total.
- `line_total_tax`- string containing the cart item line total tax.
#### _Example_
@ -343,7 +339,7 @@ Queries whether a cart item is pending quantity.
#### _Parameters_
- cartItemKey `string` - The cart item key.
- cartItemKey `string` - The cart item key.
#### _Returns_
@ -362,7 +358,7 @@ Queries whether a cart item is pending delete.
#### _Parameters_
- cartItemKey `string` - The cart item key.
- cartItemKey `string` - The cart item key.
#### _Returns_
@ -405,8 +401,6 @@ const store = select( 'wc/store/cart' );
const isShippingRateBeingSelected = store.isShippingRateBeingSelected();
```
<!-- FEEDBACK -->
---
@ -416,4 +410,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/data-store/checkout.md
View File

@ -167,4 +167,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/data-store/payment.md
View File

@ -478,4 +478,3 @@ 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 -->

32
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/data-store/validation.md
View File

@ -46,7 +46,7 @@ Returns the validation error.
#### _Parameters_
- _errorId_ `string` - The error ID to get validation errors for.
- _errorId_ `string` - The error ID to get validation errors for.
#### Example
@ -55,7 +55,6 @@ const store = select( 'wc/store/validation' );
const billingFirstNameError = store.getValidationError( 'billing-first-name' );
```
#### _Returns_
- `object`: The validation error which is an object containing _message_ (`string`) and _hidden_ (`boolean`).
@ -66,7 +65,7 @@ Gets a validation error ID for use in HTML which can be used as a CSS selector,
#### _Parameters_
- _errorId_ `string` - The error ID to get the validation error ID for.
- _errorId_ `string` - The error ID to get the validation error ID for.
#### _Returns_
@ -88,7 +87,7 @@ Clears a validation error.
#### _Parameters_
- _errorId_ `string` - The error ID to clear validation errors for.
- _errorId_ `string` - The error ID to clear validation errors for.
#### Example
@ -103,7 +102,7 @@ Clears multiple validation errors at once. If no error IDs are passed, all valid
#### _Parameters_
- _errors_ `string[] | undefined` - The error IDs to clear validation errors for. This can be undefined, and if it is, all validation errors will be cleared.
- _errors_ `string[] | undefined` - The error IDs to clear validation errors for. This can be undefined, and if it is, all validation errors will be cleared.
#### Example
@ -111,7 +110,11 @@ Clears multiple validation errors at once. If no error IDs are passed, all valid
```js
const store = dispatch( 'wc/store/validation' );
store.clearValidationErrors( [ 'billing-first-name', 'billing-last-name', 'terms-and-conditions' ] );
store.clearValidationErrors( [
'billing-first-name',
'billing-last-name',
'terms-and-conditions',
] );
```
2. This will clear all validation errors.
@ -136,14 +139,14 @@ const { dispatch } = wp.data;
const { setValidationErrors } = dispatch( 'wc/store/validation' );
setValidationErrors( {
'billing-first-name': {
message: 'First name is required.',
hidden: false,
},
'billing-last-name': {
message: 'Last name is required.',
hidden: false,
},
'billing-first-name': {
message: 'First name is required.',
hidden: false,
},
'billing-last-name': {
message: 'Last name is required.',
hidden: false,
},
} );
```
@ -203,4 +206,3 @@ 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 -->

402
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/hooks/actions.md
View File

@ -6,48 +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_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
Fires when a deprecated function is called.
```php
@ -56,21 +54,18 @@ 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
@ -79,25 +74,23 @@ 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
@ -110,20 +103,17 @@ 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
@ -132,44 +122,38 @@ 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
@ -178,20 +162,17 @@ 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
@ -204,22 +185,19 @@ 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
@ -228,21 +206,18 @@ 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
@ -251,15 +226,13 @@ 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
@ -268,14 +241,12 @@ 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
@ -284,14 +255,12 @@ 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
@ -300,14 +269,12 @@ 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
@ -316,14 +283,12 @@ 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
@ -332,14 +297,12 @@ 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
@ -352,13 +315,11 @@ 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.
@ -372,30 +333,26 @@ 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
@ -404,21 +361,18 @@ 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
@ -427,22 +381,20 @@ 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
@ -451,26 +403,22 @@ 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
@ -479,22 +427,20 @@ 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)
- [StoreApi/Routes/V1/Checkout.php](../../../../src/StoreApi/Routes/V1/Checkout.php)
---
## woocommerce_rest_checkout_process_payment_with_context
Process payment with context.
```php
@ -503,26 +449,23 @@ do_action_ref_array( 'woocommerce_rest_checkout_process_payment_with_context', [
### 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. |
| 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
@ -531,14 +474,12 @@ 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
@ -551,10 +492,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
@ -573,17 +514,14 @@ 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
@ -596,22 +534,20 @@ 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
@ -620,21 +556,19 @@ 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
@ -643,22 +577,20 @@ 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
@ -671,9 +603,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
@ -689,22 +621,18 @@ 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/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
@ -713,21 +641,19 @@ 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. |
| 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/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
@ -740,21 +666,19 @@ do_action( 'woocommerce_store_api_checkout_update_order_from_request', \WC_Order
### Parameters
| Argument | Type | Description |
| -------- | ---- | ----------- |
| $order | \WC_Order | Order object. |
| Argument | Type | Description |
| -------- | ---------------- | ------------------------------- |
| $order | \WC_Order | Order 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/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
@ -767,25 +691,22 @@ 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
@ -794,20 +715,18 @@ 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
@ -820,21 +739,19 @@ 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
@ -843,20 +760,18 @@ 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.
@ -866,14 +781,12 @@ 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
@ -882,10 +795,10 @@ do_action( '{$hook}' )
### Source
- [Templates/AbstractTemplateCompatibility.php](../../../../src/Templates/AbstractTemplateCompatibility.php)
- [Templates/AbstractTemplateCompatibility.php](../../../../src/Templates/AbstractTemplateCompatibility.php)
---
<!-- FEEDBACK -->
---
@ -895,4 +808,3 @@ 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 -->

529
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/hooks/filters.md
View File

File diff suppressed because it is too large Load Diff

25
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/rest-api/available-endpoints-to-extend.md
View File

@ -2,18 +2,18 @@
## Table of Contents <!-- omit in toc -->
- [`wc/store/checkout`](#wcstorecheckout)
- [Passed Parameters](#passed-parameters)
- [Key](#key)
- [`wc/store/cart`](#wcstorecart)
- [Passed Parameters](#passed-parameters-1)
- [Key](#key-1)
- [`wc/store/cart/items`](#wcstorecartitems)
- [Passed Parameters](#passed-parameters-2)
- [Key](#key-2)
- [`wc/store/products`](#wcstoreproducts)
- [Passed Parameters](#passed-parameters-3)
- [Key](#key-3)
- [`wc/store/checkout`](#wcstorecheckout)
- [Passed Parameters](#passed-parameters)
- [Key](#key)
- [`wc/store/cart`](#wcstorecart)
- [Passed Parameters](#passed-parameters-1)
- [Key](#key-1)
- [`wc/store/cart/items`](#wcstorecartitems)
- [Passed Parameters](#passed-parameters-2)
- [Key](#key-2)
- [`wc/store/products`](#wcstoreproducts)
- [Passed Parameters](#passed-parameters-3)
- [Key](#key-3)
To see how to add your data to Store API using ExtendSchema, [check this document](./extend-rest-api-add-data.md). If you want to add a new endpoint, [check this document](./extend-rest-api-new-endpoint.md).
@ -80,4 +80,3 @@ 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 -->

21
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/rest-api/extend-rest-api-add-data.md
View File

@ -2,16 +2,16 @@
## Table of Contents <!-- omit in toc -->
- [The problem](#the-problem)
- [Solution](#solution)
- [Basic usage](#basic-usage)
- [Things To Consider](#things-to-consider)
- [ExtendSchema is a shared instance](#extendschema-is-a-shared-instance)
- [Errors and fatals are silence for non-admins](#errors-and-fatals-are-silence-for-non-admins)
- [Callbacks should always return an array](#callbacks-should-always-return-an-array)
- [API Definition](#api-definition)
- [Putting it all together](#putting-it-all-together)
- [Formatting your data](#formatting-your-data)
- [The problem](#the-problem)
- [Solution](#solution)
- [Basic usage](#basic-usage)
- [Things To Consider](#things-to-consider)
- [ExtendSchema is a shared instance](#extendschema-is-a-shared-instance)
- [Errors and fatals are silence for non-admins](#errors-and-fatals-are-silence-for-non-admins)
- [Callbacks should always return an array](#callbacks-should-always-return-an-array)
- [API Definition](#api-definition)
- [Putting it all together](#putting-it-all-together)
- [Formatting your data](#formatting-your-data)
## The problem
@ -337,4 +337,3 @@ 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 -->

21
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/rest-api/extend-rest-api-formatters.md
View File

@ -2,16 +2,16 @@
## Table of Contents <!-- omit in toc -->
- [How to use them](#how-to-use-them)
- [MoneyFormatter](#moneyformatter)
- [Arguments](#arguments)
- [Example use and returned value](#example-use-and-returned-value)
- [CurrencyFormatter](#currencyformatter)
- [Arguments](#arguments-1)
- [Example use and returned value](#example-use-and-returned-value-1)
- [HtmlFormatter](#htmlformatter)
- [Arguments](#arguments-2)
- [Example use and returned value](#example-use-and-returned-value-2)
- [How to use them](#how-to-use-them)
- [MoneyFormatter](#moneyformatter)
- [Arguments](#arguments)
- [Example use and returned value](#example-use-and-returned-value)
- [CurrencyFormatter](#currencyformatter)
- [Arguments](#arguments-1)
- [Example use and returned value](#example-use-and-returned-value-1)
- [HtmlFormatter](#htmlformatter)
- [Arguments](#arguments-2)
- [Example use and returned value](#example-use-and-returned-value-2)
`Formatters` are utility classes that allow you to format values to so that they are compatible with the StoreAPI, values such as money, currency, or HTML.
@ -142,4 +142,3 @@ alert('bad script!') This &#8220;coffee&#8221; 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 -->

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/rest-api/extend-rest-api-new-endpoint.md
View File

@ -49,4 +49,3 @@ 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 -->

1
plugins/woocommerce-blocks/docs/third-party-developers/extensibility/rest-api/extend-rest-api-update-cart.md
View File

@ -192,4 +192,3 @@ 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 -->

1
plugins/woocommerce-blocks/packages/checkout/README.md
View File

@ -62,4 +62,3 @@ 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 -->

1
plugins/woocommerce-blocks/packages/checkout/blocks-registry/README.md
View File

@ -212,4 +212,3 @@ 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 -->

1
plugins/woocommerce-blocks/packages/checkout/components/README.md
View File

@ -29,4 +29,3 @@ 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 -->

5
plugins/woocommerce-blocks/packages/checkout/filter-registry/README.md
View File

@ -47,7 +47,7 @@ type CheckoutFilterFunction = < T >(
import { registerCheckoutFilters } from '@woocommerce/blocks-checkout';
// Global import
const { registerCheckoutFilters } = wc.blocksCheckout;
const { registerCheckoutFilters } = wc.blocksCheckout;
const callback = ( value ) => {
return value;
@ -85,7 +85,7 @@ This function applies a filter, and all registered callbacks, to a given value.
import { applyCheckoutFilter } from '@woocommerce/blocks-checkout';
// Global import
const { applyCheckoutFilter } = wc.blocksCheckout;
const { applyCheckoutFilter } = wc.blocksCheckout;
const options = {
filterName: 'my-filter',
@ -132,4 +132,3 @@ 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 -->

1
plugins/woocommerce-blocks/packages/checkout/slot/README.md
View File

@ -192,4 +192,3 @@ 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 -->

1
plugins/woocommerce-blocks/packages/checkout/utils/README.md
View File

@ -81,4 +81,3 @@ 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 -->

227
plugins/woocommerce-blocks/src/BlockTemplatesController.php
View File

@ -2,10 +2,15 @@
namespace Automattic\WooCommerce\Blocks;
use Automattic\WooCommerce\Blocks\Domain\Package;
use Automattic\WooCommerce\Blocks\Templates\CartTemplate;
use Automattic\WooCommerce\Blocks\Templates\CheckoutTemplate;
use Automattic\WooCommerce\Blocks\Templates\ProductAttributeTemplate;
use Automattic\WooCommerce\Blocks\Templates\ProductSearchResultsTemplate;
use Automattic\WooCommerce\Blocks\Templates\SingleProductTemplateCompatibility;
use Automattic\WooCommerce\Blocks\Utils\BlockTemplateUtils;
use Automattic\WooCommerce\Blocks\Templates\OrderConfirmationTemplate;
use Automattic\WooCommerce\Blocks\Utils\SettingsUtils;
use \WP_Post;
/**
* BlockTypesController class.
@ -71,6 +76,44 @@ class BlockTemplatesController {
add_filter( 'taxonomy_template_hierarchy', array( $this, 'add_archive_product_to_eligible_for_fallback_templates' ), 10, 1 );
add_filter( 'post_type_archive_title', array( $this, 'update_product_archive_title' ), 10, 2 );
add_action( 'after_switch_theme', array( $this, 'check_should_use_blockified_product_grid_templates' ), 10, 2 );
if ( wc_current_theme_is_fse_theme() ) {
add_action( 'init', array( $this, 'maybe_migrate_content' ) );
add_filter( 'woocommerce_settings_pages', array( $this, 'template_permalink_settings' ) );
add_filter( 'pre_update_option', array( $this, 'update_template_permalink' ), 10, 2 );
add_action( 'woocommerce_admin_field_permalink', array( SettingsUtils::class, 'permalink_input_field' ) );
// By default, the Template Part Block only supports template parts that are in the current theme directory.
// This render_callback wrapper allows us to add support for plugin-housed template parts.
add_filter(
'block_type_metadata_settings',
function( $settings, $metadata ) {
if ( isset( $metadata['name'], $settings['render_callback'] ) && 'core/template-part' === $metadata['name'] && 'render_block_core_template_part' === $settings['render_callback'] ) {
$settings['render_callback'] = [ $this, 'render_woocommerce_template_part' ];
}
return $settings;
},
10,
2
);
}
}
/**
* Renders the `core/template-part` block on the server.
*
* @param array $attributes The block attributes.
* @return string The render.
*/
public function render_woocommerce_template_part( $attributes ) {
if ( 'woocommerce/woocommerce' === $attributes['theme'] ) {
$template_part = BlockTemplateUtils::get_block_template( $attributes['theme'] . '//' . $attributes['slug'], 'wp_template_part' );
if ( $template_part && ! empty( $template_part->content ) ) {
return do_blocks( $template_part->content );
}
}
return \render_block_core_template_part( $attributes );
}
/**
@ -340,7 +383,6 @@ class BlockTemplatesController {
if ( ! $template->description ) {
$template->description = BlockTemplateUtils::get_block_template_description( $template->slug );
}
return $template;
},
$query_result
@ -572,6 +614,22 @@ class BlockTemplatesController {
if ( ! BlockTemplateUtils::theme_has_template( 'archive-product' ) ) {
add_filter( 'woocommerce_has_block_template', '__return_true', 10, 0 );
}
} elseif (
is_cart() &&
! BlockTemplateUtils::theme_has_template( CartTemplate::get_slug() ) && $this->block_template_is_available( CartTemplate::get_slug() )
) {
add_filter( 'woocommerce_has_block_template', '__return_true', 10, 0 );
} elseif (
is_checkout() &&
! BlockTemplateUtils::theme_has_template( CheckoutTemplate::get_slug() ) && $this->block_template_is_available( CheckoutTemplate::get_slug() )
) {
add_filter( 'woocommerce_has_block_template', '__return_true', 10, 0 );
} elseif (
is_wc_endpoint_url( 'order-received' )
&& ! BlockTemplateUtils::theme_has_template( OrderConfirmationTemplate::get_slug() )
&& $this->block_template_is_available( OrderConfirmationTemplate::get_slug() )
) {
add_filter( 'woocommerce_has_block_template', '__return_true', 10, 0 );
} else {
$queried_object = get_queried_object();
if ( is_null( $queried_object ) ) {
@ -638,4 +696,171 @@ class BlockTemplatesController {
return $post_type_name;
}
/**
* Migrates page content to templates if needed.
*/
public function maybe_migrate_content() {
if ( ! $this->has_migrated_page( 'cart' ) ) {
$this->migrate_page( 'cart', CartTemplate::get_placeholder_page() );
}
if ( ! $this->has_migrated_page( 'checkout' ) ) {
$this->migrate_page( 'checkout', CheckoutTemplate::get_placeholder_page() );
}
}
/**
* Check if a page has been migrated to a template.
*
* @param string $page_id Page ID.
* @return boolean
*/
protected function has_migrated_page( $page_id ) {
return (bool) get_option( 'has_migrated_' . $page_id, false );
}
/**
* Migrates a page to a template if needed.
*
* @param string $page_id Page ID.
* @param \WP_Post $page Page object.
*/
protected function migrate_page( $page_id, $page ) {
if ( ! $page || empty( $page->post_content ) ) {
update_option( 'has_migrated_' . $page_id, '1' );
return;
}
$request = new \WP_REST_Request( 'POST', '/wp/v2/templates/woocommerce/woocommerce//' . $page_id );
$request->set_body_params(
[
'id' => 'woocommerce/woocommerce//' . $page_id,
'content' => $this->get_block_template_part( 'header' ) .
'<!-- wp:group {"layout":{"inherit":true}} -->
<div class="wp-block-group">
<!-- wp:heading {"level":1} -->
<h1 class="wp-block-heading">' . wp_kses_post( $page->post_title ) . '</h1>
<!-- /wp:heading -->
' . wp_kses_post( $page->post_content ) . '
</div>
<!-- /wp:group -->' .
$this->get_block_template_part( 'footer' ),
]
);
rest_get_server()->dispatch( $request );
update_option( 'has_migrated_' . $page_id, '1' );
}
/**
* Returns the requested template part.
*
* @param string $part The part to return.
*
* @return string
*/
protected function get_block_template_part( $part ) {
$template_part = get_block_template( get_stylesheet() . '//' . $part, 'wp_template_part' );
if ( ! $template_part || empty( $template_part->content ) ) {
return '';
}
return $template_part->content;
}
/**
* Replaces page settings in WooCommerce with text based permalinks which point to a template.
*
* @param array $settings Settings pages.
* @return array
*/
public function template_permalink_settings( $settings ) {
foreach ( $settings as $key => $setting ) {
if ( 'woocommerce_checkout_page_id' === $setting['id'] ) {
$checkout_page = CheckoutTemplate::get_placeholder_page();
$settings[ $key ] = [
'title' => __( 'Checkout page', 'woo-gutenberg-products-block' ),
'desc' => sprintf(
// translators: %1$s: opening anchor tag, %2$s: closing anchor tag.
__( 'The checkout template can be %1$s edited here%2$s.', 'woo-gutenberg-products-block' ),
'<a href="' . esc_url( admin_url( 'site-editor.php?postType=wp_template&postId=woocommerce%2Fwoocommerce%2F%2F' . CheckoutTemplate::get_slug() ) ) . '" target="_blank">',
'</a>'
),
'desc_tip' => __( 'This is the URL to the checkout page.', 'woo-gutenberg-products-block' ),
'id' => 'woocommerce_checkout_page_endpoint',
'type' => 'permalink',
'default' => $checkout_page ? $checkout_page->post_name : CheckoutTemplate::get_slug(),
'autoload' => false,
];
}
if ( 'woocommerce_cart_page_id' === $setting['id'] ) {
$cart_page = CartTemplate::get_placeholder_page();
$settings[ $key ] = [
'title' => __( 'Cart page', 'woo-gutenberg-products-block' ),
'desc' => sprintf(
// translators: %1$s: opening anchor tag, %2$s: closing anchor tag.
__( 'The cart template can be %1$s edited here%2$s.', 'woo-gutenberg-products-block' ),
'<a href="' . esc_url( admin_url( 'site-editor.php?postType=wp_template&postId=woocommerce%2Fwoocommerce%2F%2F' . CartTemplate::get_slug() ) ) . '" target="_blank">',
'</a>'
),
'desc_tip' => __( 'This is the URL to the cart page.', 'woo-gutenberg-products-block' ),
'id' => 'woocommerce_cart_page_endpoint',
'type' => 'permalink',
'default' => $cart_page ? $cart_page->post_name : CartTemplate::get_slug(),
'autoload' => false,
];
}
}
return $settings;
}
/**
* Syncs entered permalink with the pages and returns the correct value.
*
* @param string $value Value of the option.
* @param string $option Name of the option.
* @return string
*/
public function update_template_permalink( $value, $option ) {
if ( 'woocommerce_checkout_page_endpoint' === $option ) {
return $this->sync_endpoint_with_page( CheckoutTemplate::get_placeholder_page(), 'checkout', $value );
}
if ( 'woocommerce_cart_page_endpoint' === $option ) {
return $this->sync_endpoint_with_page( CartTemplate::get_placeholder_page(), 'cart', $value );
}
return $value;
}
/**
* Syncs the provided permalink with the actual WP page.
*
* @param WP_Post|null $page The page object, or null if it does not exist.
* @param string $page_slug The identifier for the page e.g. cart, checkout.
* @param string $permalink The new permalink to use.
* @return string THe actual permalink assigned to the page. May differ from $permalink if it was already taken.
*/
protected function sync_endpoint_with_page( $page, $page_slug, $permalink ) {
if ( ! $page ) {
$updated_page_id = wc_create_page(
esc_sql( $permalink ),
'woocommerce_' . $page_slug . '_page_id',
$page_slug,
'',
'',
'publish'
);
} else {
$updated_page_id = wp_update_post(
[
'ID' => $page->ID,
'post_name' => esc_sql( $permalink ),
]
);
}
// Get post again in case slug was updated with a suffix.
if ( $updated_page_id && ! is_wp_error( $updated_page_id ) ) {
return get_post( $updated_page_id )->post_name;
}
return $permalink;
}
}

47
plugins/woocommerce-blocks/src/BlockTypes/Cart.php
View File

@ -23,6 +23,52 @@ class Cart extends AbstractBlock {
*/
protected $chunks_folder = 'cart-blocks';
/**
* Initialize this block type.
*
* - Hook into WP lifecycle.
* - Register the block with WordPress.
*/
protected function initialize() {
parent::initialize();
add_action( 'wp_loaded', array( $this, 'register_patterns' ) );
}
/**
* Register block pattern for Empty Cart Message to make it translatable.
*/
public function register_patterns() {
$shop_permalink = wc_get_page_id( 'shop' ) ? get_permalink( wc_get_page_id( 'shop' ) ) : '';
register_block_pattern(
'woocommerce/cart-cross-sells-message',
array(
'title' => '',
'inserter' => false,
'content' => '<!-- wp:heading {"fontSize":"large"} --><h2 class="wp-block-heading has-large-font-size">' . esc_html__( 'You may be interested in…', 'woo-gutenberg-products-block' ) . '</h2><!-- /wp:heading -->',
)
);
register_block_pattern(
'woocommerce/cart-empty-message',
array(
'title' => '',
'inserter' => false,
'content' => '
<!-- wp:heading {"textAlign":"center","className":"with-empty-cart-icon wc-block-cart__empty-cart__title"} --><h2 class="wp-block-heading has-text-align-center with-empty-cart-icon wc-block-cart__empty-cart__title">' . esc_html__( 'Your cart is currently empty!', 'woo-gutenberg-products-block' ) . '</h2><!-- /wp:heading -->
<!-- wp:paragraph {"align":"center"} --><p class="has-text-align-center"><a href="' . esc_attr( esc_url( $shop_permalink ) ) . '">' . esc_html__( 'Browse store', 'woo-gutenberg-products-block' ) . '</a></p><!-- /wp:paragraph -->
',
)
);
register_block_pattern(
'woocommerce/cart-new-in-store-message',
array(
'title' => '',
'inserter' => false,
'content' => '<!-- wp:heading {"textAlign":"center"} --><h2 class="wp-block-heading has-text-align-center">' . esc_html__( 'New in store', 'woo-gutenberg-products-block' ) . '</h2><!-- /wp:heading -->',
)
);
}
/**
* Get the editor script handle for this block type.
*
@ -169,6 +215,7 @@ class Cart extends AbstractBlock {
$this->asset_data_registry->add( 'shippingEnabled', wc_shipping_enabled(), true );
$this->asset_data_registry->add( 'hasDarkEditorStyleSupport', current_theme_supports( 'dark-editor-style' ), true );
$this->asset_data_registry->register_page_id( isset( $attributes['checkoutPageId'] ) ? $attributes['checkoutPageId'] : 0 );
$this->asset_data_registry->add( 'isBlockTheme', wc_current_theme_is_fse_theme(), true );
$pickup_location_settings = get_option( 'woocommerce_pickup_location_settings', [] );
$this->asset_data_registry->add( 'localPickupEnabled', wc_string_to_bool( $pickup_location_settings['enabled'] ?? 'no' ), true );

1
plugins/woocommerce-blocks/src/BlockTypes/Checkout.php
View File

@ -212,6 +212,7 @@ class Checkout extends AbstractBlock {
$this->asset_data_registry->add( 'shippingEnabled', wc_shipping_enabled(), true );
$this->asset_data_registry->add( 'hasDarkEditorStyleSupport', current_theme_supports( 'dark-editor-style' ), true );
$this->asset_data_registry->register_page_id( isset( $attributes['cartPageId'] ) ? $attributes['cartPageId'] : 0 );
$this->asset_data_registry->add( 'isBlockTheme', wc_current_theme_is_fse_theme(), true );
$pickup_location_settings = get_option( 'woocommerce_pickup_location_settings', [] );
$this->asset_data_registry->add( 'localPickupEnabled', wc_string_to_bool( $pickup_location_settings['enabled'] ?? 'no' ), true );

74
plugins/woocommerce-blocks/src/BlockTypes/ClassicTemplate.php
View File

@ -3,8 +3,9 @@ namespace Automattic\WooCommerce\Blocks\BlockTypes;
use Automattic\WooCommerce\Blocks\Templates\ProductAttributeTemplate;
use Automattic\WooCommerce\Blocks\Templates\ProductSearchResultsTemplate;
use Automattic\WooCommerce\Blocks\Templates\OrderConfirmationTemplate;
use Automattic\WooCommerce\Blocks\Utils\StyleAttributesUtils;
use WC_Query;
use WC_Shortcode_Checkout;
/**
* Classic Single Product class
@ -35,7 +36,23 @@ class ClassicTemplate extends AbstractDynamicBlock {
parent::initialize();
add_filter( 'render_block', array( $this, 'add_alignment_class_to_wrapper' ), 10, 2 );
add_filter( 'woocommerce_product_query_meta_query', array( $this, 'filter_products_by_stock' ) );
add_action( 'enqueue_block_assets', array( $this, 'enqueue_block_assets' ) );
}
/**
* Enqueue assets used for rendering the block in editor context.
*
* This is needed if a block is not yet within the post content--`render` and `enqueue_assets` may not have ran.
*/
public function enqueue_block_assets() {
// Ensures frontend styles for blocks exist in the site editor iframe.
if ( class_exists( 'WC_Frontend_Scripts' ) && is_admin() ) {
$frontend_scripts = new \WC_Frontend_Scripts();
$styles = $frontend_scripts::get_styles();
foreach ( $styles as $handle => $style ) {
wp_enqueue_style( $handle, $style['src'], $style['deps'], $style['version'], $style['media'] );
}
}
}
/**
@ -62,11 +79,23 @@ class ClassicTemplate extends AbstractDynamicBlock {
$frontend_scripts::load_scripts();
}
$archive_templates = array( 'archive-product', 'taxonomy-product_cat', 'taxonomy-product_tag', ProductAttributeTemplate::SLUG, ProductSearchResultsTemplate::SLUG );
if ( OrderConfirmationTemplate::get_slug() === $attributes['template'] ) {
return $this->render_order_received();
}
if ( 'single-product' === $attributes['template'] ) {
return $this->render_single_product();
} elseif ( in_array( $attributes['template'], $archive_templates, true ) ) {
}
$archive_templates = array(
'archive-product',
'taxonomy-product_cat',
'taxonomy-product_tag',
ProductAttributeTemplate::SLUG,
ProductSearchResultsTemplate::SLUG,
);
if ( in_array( $attributes['template'], $archive_templates, true ) ) {
// Set this so that our product filters can detect if it's a PHP template.
$this->asset_data_registry->add( 'is_rendering_php_template', true, true );
@ -80,14 +109,39 @@ class ClassicTemplate extends AbstractDynamicBlock {
);
return $this->render_archive_product();
} else {
ob_start();
echo "You're using the ClassicTemplate block";
wp_reset_postdata();
return ob_get_clean();
}
ob_start();
echo "You're using the ClassicTemplate block";
wp_reset_postdata();
return ob_get_clean();
}
/**
* Render method for rendering the order confirmation template.
*
* @return string Rendered block type output.
*/
protected function render_order_received() {
ob_start();
echo '<div class="wp-block-group">';
echo sprintf(
'<%1$s %2$s>%3$s</%1$s>',
'h1',
get_block_wrapper_attributes(), // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
esc_html__( 'Order confirmation', 'woo-gutenberg-products-block' )
);
WC_Shortcode_Checkout::output( array() );
echo '</div>';
return ob_get_clean();
}
/**

32
plugins/woocommerce-blocks/src/Domain/Bootstrap.php
View File

@ -22,7 +22,11 @@ use Automattic\WooCommerce\Blocks\Payments\Integrations\Cheque;
use Automattic\WooCommerce\Blocks\Payments\Integrations\PayPal;
use Automattic\WooCommerce\Blocks\Payments\PaymentMethodRegistry;
use Automattic\WooCommerce\Blocks\Registry\Container;
use Automattic\WooCommerce\Blocks\Templates\CartTemplate;
use Automattic\WooCommerce\Blocks\Templates\CheckoutHeaderTemplate;
use Automattic\WooCommerce\Blocks\Templates\CheckoutTemplate;
use Automattic\WooCommerce\Blocks\Templates\ClassicTemplatesCompatibility;
use Automattic\WooCommerce\Blocks\Templates\OrderConfirmationTemplate;
use Automattic\WooCommerce\Blocks\Templates\ProductAttributeTemplate;
use Automattic\WooCommerce\Blocks\Templates\ProductSearchResultsTemplate;
use Automattic\WooCommerce\StoreApi\RoutesController;
@ -132,6 +136,10 @@ class Bootstrap {
$this->container->get( BlockTemplatesController::class );
$this->container->get( ProductSearchResultsTemplate::class );
$this->container->get( ProductAttributeTemplate::class );
$this->container->get( CartTemplate::class );
$this->container->get( CheckoutTemplate::class );
$this->container->get( CheckoutHeaderTemplate::class );
$this->container->get( OrderConfirmationTemplate::class );
$this->container->get( ClassicTemplatesCompatibility::class );
$this->container->get( ArchiveProductTemplatesCompatibility::class )->init();
$this->container->get( SingleProductTemplateCompatibility::class )->init();
@ -273,6 +281,30 @@ class Bootstrap {
return new ProductAttributeTemplate();
}
);
$this->container->register(
CartTemplate::class,
function () {
return new CartTemplate();
}
);
$this->container->register(
CheckoutTemplate::class,
function () {
return new CheckoutTemplate();
}
);
$this->container->register(
CheckoutHeaderTemplate::class,
function () {
return new CheckoutHeaderTemplate();
}
);
$this->container->register(
OrderConfirmationTemplate::class,
function () {
return new OrderConfirmationTemplate();
}
);
$this->container->register(
ClassicTemplatesCompatibility::class,
function ( Container $container ) {

15
plugins/woocommerce-blocks/src/StoreApi/README.md
View File

@ -2,13 +2,13 @@
## Table of contents <!-- omit in toc -->
- [Requirements and limitations](#requirements-and-limitations)
- [Store API Namespace](#store-api-namespace)
- [Resources and endpoints](#resources-and-endpoints)
- [Pagination](#pagination)
- [Status codes](#status-codes)
- [Contributing](#contributing)
- [Extensibility](#extensibility)
- [Requirements and limitations](#requirements-and-limitations)
- [Store API Namespace](#store-api-namespace)
- [Resources and endpoints](#resources-and-endpoints)
- [Pagination](#pagination)
- [Status codes](#status-codes)
- [Contributing](#contributing)
- [Extensibility](#extensibility)
**The Store API provides public Rest API endpoints for the development of customer-facing cart, checkout, and product functionality. It follows many of the patterns used in the [WordPress REST API](https://developer.wordpress.org/rest-api/key-concepts/).**
@ -172,4 +172,3 @@ 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 -->

11
plugins/woocommerce-blocks/src/StoreApi/docs/cart-coupons.md
View File

@ -2,11 +2,11 @@
## Table of Contents <!-- omit in toc -->
- [List Cart Coupons](#list-cart-coupons)
- [Single Cart Coupon](#single-cart-coupon)
- [Add Cart Coupon](#add-cart-coupon)
- [Delete Single Cart Coupon](#delete-single-cart-coupon)
- [Delete All Cart Coupons](#delete-all-cart-coupons)
- [List Cart Coupons](#list-cart-coupons)
- [Single Cart Coupon](#single-cart-coupon)
- [Add Cart Coupon](#add-cart-coupon)
- [Delete Single Cart Coupon](#delete-single-cart-coupon)
- [Delete All Cart Coupons](#delete-all-cart-coupons)
## List Cart Coupons
@ -171,4 +171,3 @@ 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 -->

13
plugins/woocommerce-blocks/src/StoreApi/docs/cart-items.md
View File

@ -2,12 +2,12 @@
## Table of Contents <!-- omit in toc -->
- [List Cart Items](#list-cart-items)
- [Single Cart Item](#single-cart-item)
- [Add Cart Item](#add-cart-item)
- [Edit Single Cart Item](#edit-single-cart-item)
- [Delete Single Cart Item](#delete-single-cart-item)
- [Delete All Cart Items](#delete-all-cart-items)
- [List Cart Items](#list-cart-items)
- [Single Cart Item](#single-cart-item)
- [Add Cart Item](#add-cart-item)
- [Edit Single Cart Item](#edit-single-cart-item)
- [Delete Single Cart Item](#delete-single-cart-item)
- [Delete All Cart Items](#delete-all-cart-items)
## List Cart Items
@ -369,4 +369,3 @@ 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 -->

87
plugins/woocommerce-blocks/src/StoreApi/docs/checkout.md
View File

@ -2,15 +2,15 @@
## Table of Contents <!-- omit in toc -->
- [Get Checkout Data](#get-checkout-data)
- [Process Order and Payment](#process-order-and-payment)
- [Get Checkout Data](#get-checkout-data)
- [Process Order and Payment](#process-order-and-payment)
The checkout API facilitates the creation of orders (from the current cart) and handling payments for payment methods.
All checkout endpoints require [Nonce Tokens](nonce-tokens.md).
- [Get Checkout Data](#get-checkout-data)
- [Process Order and Payment](#process-order-and-payment)
- [Get Checkout Data](#get-checkout-data)
- [Process Order and Payment](#process-order-and-payment)
## Get Checkout Data
@ -121,15 +121,15 @@ curl --header "Nonce: 12345" --request POST https://example-store.com/wp-json/wc
"postcode": "10023",
"country": "US"
},
"customer_note": "Test notes on order.",
"create_account": false,
"payment_method": "cheque",
"payment_data": [],
"extensions": {
"some-extension-name": {
"some-data-key": "some data value"
}
}
"customer_note": "Test notes on order.",
"create_account": false,
"payment_method": "cheque",
"payment_data": [],
"extensions": {
"some-extension-name": {
"some-data-key": "some data value"
}
}
}
```
@ -185,36 +185,36 @@ For further information on generating a `stripe_source` please check [the Stripe
```json
{
"payment_data": [
{
"key": "stripe_source",
"value": "src_xxxxxxxxxxxxx"
},
{
"key": "billing_email",
"value": "myemail@email.com"
},
{
"key": "billing_first_name",
"value": "Jane"
},
{
"key": "billing_last_name",
"value": "Doe"
},
{
"key": "paymentMethod",
"value": "stripe"
},
{
"key": "paymentRequestType",
"value": "cc"
},
{
"key": "wc-stripe-new-payment-method",
"value": true
}
]
"payment_data": [
{
"key": "stripe_source",
"value": "src_xxxxxxxxxxxxx"
},
{
"key": "billing_email",
"value": "myemail@email.com"
},
{
"key": "billing_first_name",
"value": "Jane"
},
{
"key": "billing_last_name",
"value": "Doe"
},
{
"key": "paymentMethod",
"value": "stripe"
},
{
"key": "paymentRequestType",
"value": "cc"
},
{
"key": "wc-stripe-new-payment-method",
"value": true
}
]
}
```
@ -227,4 +227,3 @@ 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 -->

17
plugins/woocommerce-blocks/src/StoreApi/docs/guiding-principles.md
View File

@ -2,14 +2,14 @@
## Table of Contents <!-- omit in toc -->
- [Routes must include a well-defined JSON schema](#routes-must-include-a-well-defined-json-schema)
- [Routes should be designed around resources with a single type of schema](#routes-should-be-designed-around-resources-with-a-single-type-of-schema)
- [Error Handling](#error-handling)
- [Cart Operations](#cart-operations)
- [Exposed data must belong to the current user or be non-sensitive](#exposed-data-must-belong-to-the-current-user-or-be-non-sensitive)
- [Collections of resources should be paginated](#collections-of-resources-should-be-paginated)
- [API Responses should use standard HTTP status codes](#api-responses-should-use-standard-http-status-codes)
- [Breaking changes should be avoided where possible](#breaking-changes-should-be-avoided-where-possible)
- [Routes must include a well-defined JSON schema](#routes-must-include-a-well-defined-json-schema)
- [Routes should be designed around resources with a single type of schema](#routes-should-be-designed-around-resources-with-a-single-type-of-schema)
- [Error Handling](#error-handling)
- [Cart Operations](#cart-operations)
- [Exposed data must belong to the current user or be non-sensitive](#exposed-data-must-belong-to-the-current-user-or-be-non-sensitive)
- [Collections of resources should be paginated](#collections-of-resources-should-be-paginated)
- [API Responses should use standard HTTP status codes](#api-responses-should-use-standard-http-status-codes)
- [Breaking changes should be avoided where possible](#breaking-changes-should-be-avoided-where-possible)
The following principles should be considered when extending, creating, or updating endpoints in the Store API.
@ -140,4 +140,3 @@ 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 -->

9
plugins/woocommerce-blocks/src/StoreApi/docs/nonce-tokens.md
View File

@ -2,10 +2,10 @@
## Table of Contents <!-- omit in toc -->
- [Store API Endpoints that Require Nonces](#store-api-endpoints-that-require-nonces)
- [Sending Nonce Tokens with requests](#sending-nonce-tokens-with-requests)
- [Generating security nonces from WordPress](#generating-security-nonces-from-wordpress)
- [Disabling Nonces for Development](#disabling-nonces-for-development)
- [Store API Endpoints that Require Nonces](#store-api-endpoints-that-require-nonces)
- [Sending Nonce Tokens with requests](#sending-nonce-tokens-with-requests)
- [Generating security nonces from WordPress](#generating-security-nonces-from-wordpress)
- [Disabling Nonces for Development](#disabling-nonces-for-development)
Nonces are generated numbers used to verify origin and intent of requests for security purposes. You can read more about [nonces in the WordPress codex](https://developer.wordpress.org/plugins/security/nonces/).
@ -56,4 +56,3 @@ 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 -->

1
plugins/woocommerce-blocks/src/StoreApi/docs/product-attribute-terms.md
View File

@ -43,4 +43,3 @@ 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 -->

5
plugins/woocommerce-blocks/src/StoreApi/docs/product-attributes.md
View File

@ -2,8 +2,8 @@
## Table of Contents <!-- omit in toc -->
- [List Product Attributes](#list-product-attributes)
- [Single Product Attribute](#single-product-attribute)
- [List Product Attributes](#list-product-attributes)
- [Single Product Attribute](#single-product-attribute)
## List Product Attributes
@ -78,4 +78,3 @@ 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 -->

5
plugins/woocommerce-blocks/src/StoreApi/docs/product-categories.md
View File

@ -2,8 +2,8 @@
## Table of Contents <!-- omit in toc -->
- [List Product Categories](#list-product-categories)
- [Single Product Category](#single-product-category)
- [List Product Categories](#list-product-categories)
- [Single Product Category](#single-product-category)
## List Product Categories
@ -95,4 +95,3 @@ 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 -->

5
plugins/woocommerce-blocks/src/StoreApi/docs/product-collection-data.md
View File

@ -11,9 +11,9 @@ GET /products/collection-data?calculate_rating_counts=true
| Attribute | Type | Required | Description |
| :--------------------------- | :----- | :------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `calculate_price_range` | bool | No | Returns the min and max price for the product collection. If false, only `null` will be returned. |
| `calculate_price_range` | bool | No | Returns the min and max price for the product collection. If false, only `null` will be returned. |
| `calculate_attribute_counts` | object | No | Returns attribute counts for a list of attribute taxonomies you pass in via this parameter. Each should be provided as an object with keys "taxonomy" and "query_type". If empty, `null` will be returned. |
| `calculate_rating_counts` | bool | No | Returns the counts of products with a certain average rating, 1-5. If false, only `null` will be returned. |
| `calculate_rating_counts` | bool | No | Returns the counts of products with a certain average rating, 1-5. If false, only `null` will be returned. |
**In addition to the above attributes**, all product list attributes are supported. This allows you to get data for a certain subset of products. See [the products API list products section](products.md#list-products) for the full list.
@ -73,4 +73,3 @@ 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 -->

3
plugins/woocommerce-blocks/src/StoreApi/docs/product-reviews.md
View File

@ -2,7 +2,7 @@
## Table of Contents <!-- omit in toc -->
- [List Product Reviews](#list-product-reviews)
- [List Product Reviews](#list-product-reviews)
## List Product Reviews
@ -72,4 +72,3 @@ 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 -->

3
plugins/woocommerce-blocks/src/StoreApi/docs/product-tags.md
View File

@ -2,7 +2,7 @@
## Table of Contents <!-- omit in toc -->
- [List Product Tags](#list-product-tags)
- [List Product Tags](#list-product-tags)
## List Product Tags
@ -48,4 +48,3 @@ 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 -->

65
plugins/woocommerce-blocks/src/StoreApi/docs/products.md
View File

@ -2,8 +2,8 @@
## Table of Contents <!-- omit in toc -->
- [List Products](#list-products)
- [Single Product](#single-product)
- [List Products](#list-products)
- [Single Product](#single-product)
The store products API provides public product data so it can be rendered on the client side.
@ -39,37 +39,37 @@ GET /products?return_attribute_counts=pa_size,pa_color
GET /products?return_rating_counts=true
```
| Attribute | Type | Required | Description |
|:--------------------------------------------|:--------| :------: |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `search` | integer | no | Limit results to those matching a string. |
| `slug` | string | no | Limit result set to products with specific slug(s). Use commas to separate. |
| `after` | string | no | Limit response to resources created after a given ISO8601 compliant date. |
| `before` | string | no | Limit response to resources created before a given ISO8601 compliant date. |
| `date_column` | string | no | When limiting response using after/before, which date column to compare against. Allowed values: `date`, `date_gmt`, `modified`, `modified_gmt` |
| `exclude` | array | no | Ensure result set excludes specific IDs. |
| `include` | array | no | Limit result set to specific ids. |
| `offset` | integer | no | Offset the result set by a specific number of items. |
| `order` | string | no | Order sort attribute ascending or descending. Allowed values: `asc`, `desc` |
| `orderby` | string | no | Sort collection by object attribute. Allowed values : `date`, `modified`, `id`, `include`, `title`, `slug`, `price`, `popularity`, `rating`, `menu_order`, `comment_count` |
| `parent` | array | no | Limit result set to those of particular parent IDs. |
| `parent_exclude` | array | no | Limit result set to all items except those of a particular parent ID. |
| `type` | string | no | Limit result set to products assigned a specific type. |
| `sku` | string | no | Limit result set to products with specific SKU(s). Use commas to separate. |
| `featured` | boolean | no | Limit result set to featured products. |
| `category` | string | no | Limit result set to products assigned a specific category ID. |
| `category_operator` | string | no | Operator to compare product category terms. Allowed values: `in`, `not_in`, `and` |
| `_unstable_tax_[product-taxonomy]` | string | no | Limit result set to products assigned to the term ID of that custom product taxonomy. `[product-taxonomy]` should be the key of the custom product taxonomy registered. |
| `_unstable_tax_[product-taxonomy]_operator` | string | no | Operator to compare custom product taxonomy terms. Allowed values: `in`, `not_in`, `and` |
| `tag` | string | no | Limit result set to products assigned a specific tag ID. |
| `tag_operator` | string | no | Operator to compare product tags. Allowed values: `in`, `not_in`, `and` |
| `on_sale` | boolean | no | Limit result set to products on sale. |
| Attribute | Type | Required | Description |
| :------------------------------------------ | :------ | :------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `search` | integer | no | Limit results to those matching a string. |
| `slug` | string | no | Limit result set to products with specific slug(s). Use commas to separate. |
| `after` | string | no | Limit response to resources created after a given ISO8601 compliant date. |
| `before` | string | no | Limit response to resources created before a given ISO8601 compliant date. |
| `date_column` | string | no | When limiting response using after/before, which date column to compare against. Allowed values: `date`, `date_gmt`, `modified`, `modified_gmt` |
| `exclude` | array | no | Ensure result set excludes specific IDs. |
| `include` | array | no | Limit result set to specific ids. |
| `offset` | integer | no | Offset the result set by a specific number of items. |
| `order` | string | no | Order sort attribute ascending or descending. Allowed values: `asc`, `desc` |
| `orderby` | string | no | Sort collection by object attribute. Allowed values : `date`, `modified`, `id`, `include`, `title`, `slug`, `price`, `popularity`, `rating`, `menu_order`, `comment_count` |
| `parent` | array | no | Limit result set to those of particular parent IDs. |
| `parent_exclude` | array | no | Limit result set to all items except those of a particular parent ID. |
| `type` | string | no | Limit result set to products assigned a specific type. |
| `sku` | string | no | Limit result set to products with specific SKU(s). Use commas to separate. |
| `featured` | boolean | no | Limit result set to featured products. |
| `category` | string | no | Limit result set to products assigned a specific category ID. |
| `category_operator` | string | no | Operator to compare product category terms. Allowed values: `in`, `not_in`, `and` |
| `_unstable_tax_[product-taxonomy]` | string | no | Limit result set to products assigned to the term ID of that custom product taxonomy. `[product-taxonomy]` should be the key of the custom product taxonomy registered. |
| `_unstable_tax_[product-taxonomy]_operator` | string | no | Operator to compare custom product taxonomy terms. Allowed values: `in`, `not_in`, `and` |
| `tag` | string | no | Limit result set to products assigned a specific tag ID. |
| `tag_operator` | string | no | Operator to compare product tags. Allowed values: `in`, `not_in`, `and` |
| `on_sale` | boolean | no | Limit result set to products on sale. |
| `min_price` | string | no | Limit result set to products based on a minimum price, provided using the smallest unit of the currency. E.g. provide 10025 for 100.25 USD, which is a two-decimal currency, and 1025 for 1025 JPY, which is a zero-decimal currency. |
| `max_price` | string | no | Limit result set to products based on a maximum price, provided using the smallest unit of the currency. E.g. provide 10025 for 100.25 USD, which is a two-decimal currency, and 1025 for 1025 JPY, which is a zero-decimal currency. |
| `stock_status` | array | no | Limit result set to products with specified stock statuses. Expects an array of strings containing 'instock', 'outofstock' or 'onbackorder'. |
| `attributes` | array | no | Limit result set to specific attribute terms. Expects an array of objects containing `attribute` (taxonomy), `term_id` or `slug`, and optional `operator` for comparison. |
| `attribute_relation` | string | no | The logical relationship between attributes when filtering across multiple at once. |
| `catalog_visibility` | string | no | Determines if hidden or visible catalog products are shown. Allowed values: `any`, `visible`, `catalog`, `search`, `hidden` |
| `rating` | boolean | no | Limit result set to products with a certain average rating. |
| `stock_status` | array | no | Limit result set to products with specified stock statuses. Expects an array of strings containing 'instock', 'outofstock' or 'onbackorder'. |
| `attributes` | array | no | Limit result set to specific attribute terms. Expects an array of objects containing `attribute` (taxonomy), `term_id` or `slug`, and optional `operator` for comparison. |
| `attribute_relation` | string | no | The logical relationship between attributes when filtering across multiple at once. |
| `catalog_visibility` | string | no | Determines if hidden or visible catalog products are shown. Allowed values: `any`, `visible`, `catalog`, `search`, `hidden` |
| `rating` | boolean | no | Limit result set to products with a certain average rating. |
```sh
curl "https://example-store.com/wp-json/wc/store/v1/products"
@ -204,7 +204,7 @@ GET /products/:slug
```
| Attribute | Type | Required | Description |
|:----------|:-------| :------: |:-------------------------------------|
| :-------- | :----- | :------: | :----------------------------------- |
| `slug` | string | Yes | The slug of the product to retrieve. |
```sh
@ -279,4 +279,3 @@ 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 -->

34
plugins/woocommerce-blocks/src/StoreApi/docs/rate-limiting.md
View File

@ -1,15 +1,15 @@
# Rate Limiting for Store API endpoints <!-- omit in toc -->
# Rate Limiting for Store API endpoints <!-- omit in toc -->
## Table of Contents <!-- omit in toc -->
- [Limit information](#limit-information)
- [Methods restricted by Rate Limiting](#methods-restricted-by-rate-limiting)
- [Rate Limiting options filter](#rate-limiting-options-filter)
- [Proxy standard support](#proxy-standard-support)
- [Limit usage information observability](#limit-usage-information-observability)
- [Response headers example](#response-headers-example)
- [Tracking limit abuses](#tracking-limit-abuses)
- [Custom tracking usage example](#custom-tracking-usage-example)
- [Limit information](#limit-information)
- [Methods restricted by Rate Limiting](#methods-restricted-by-rate-limiting)
- [Rate Limiting options filter](#rate-limiting-options-filter)
- [Proxy standard support](#proxy-standard-support)
- [Limit usage information observability](#limit-usage-information-observability)
- [Response headers example](#response-headers-example)
- [Tracking limit abuses](#tracking-limit-abuses)
- [Custom tracking usage example](#custom-tracking-usage-example)
[Rate Limiting](https://github.com/woocommerce/woocommerce-blocks/pull/5962) is available for Store API endpoints. This is optional and disabled by default. It can be enabled by following [these instructions](#rate-limiting-options-filter).
@ -19,7 +19,6 @@ Rate limit tracking is controlled by either `USER ID` (logged in) or `IP ADDRESS
It also offers standard support for running behind a proxy, load balancer, etc. This also optional and disabled by default.
## Limit information
A default maximum of 25 requests can be made within a 10-second time frame. These can be changed through an [options filter](#rate-limiting-options-filter).
@ -47,9 +46,9 @@ add_filter( 'woocommerce_store_api_rate_limit_options', function() {
If the Store is running behind a proxy, load balancer, cache service, CDNs, etc. keying limits by IP is supported through standard IP forwarding headers, namely:
- `X_REAL_IP`|`CLIENT_IP` *Custom popular implementations that simplify obtaining the origin IP for the request*
- `X_FORWARDED_FOR` *De-facto standard header for identifying the originating IP, [Documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For)*
- `X_FORWARDED` *[Documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Forwarded), [RFC 7239](https://datatracker.ietf.org/doc/html/rfc7239)*
- `X_REAL_IP`|`CLIENT_IP` _Custom popular implementations that simplify obtaining the origin IP for the request_
- `X_FORWARDED_FOR` _De-facto standard header for identifying the originating IP, [Documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For)_
- `X_FORWARDED` _[Documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Forwarded), [RFC 7239](https://datatracker.ietf.org/doc/html/rfc7239)_
This is disabled by default.
@ -57,10 +56,10 @@ This is disabled by default.
Current limit information can be observed via custom response headers:
- `RateLimit-Limit` *Maximum requests per time frame.*
- `RateLimit-Remaining` *Requests available during current time frame.*
- `RateLimit-Reset` *Unix timestamp of next time frame reset.*
- `RateLimit-Retry-After` *Seconds until requests are unblocked again. Only shown when the limit is reached.*
- `RateLimit-Limit` _Maximum requests per time frame._
- `RateLimit-Remaining` _Requests available during current time frame._
- `RateLimit-Reset` _Unix timestamp of next time frame reset._
- `RateLimit-Retry-After` _Seconds until requests are unblocked again. Only shown when the limit is reached._
### Response headers example
@ -101,4 +100,3 @@ 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 -->

110
plugins/woocommerce-blocks/src/Templates/AbstractPageTemplate.php Normal file
View File

@ -0,0 +1,110 @@
<?php
namespace Automattic\WooCommerce\Blocks\Templates;
/**
* AbstractPageTemplate class.
*
* Shared logic for page templates.
*
* @internal
*/
abstract class AbstractPageTemplate {
/**
* Page Template functionality is only initialized when using a block theme.
*/
public function __construct() {
if ( wc_current_theme_is_fse_theme() ) {
$this->init();
}
}
/**
* Initialization method.
*/
protected function init() {
add_filter( 'page_template_hierarchy', array( $this, 'page_template_hierarchy' ), 1 );
add_action( 'current_screen', array( $this, 'page_template_editor_redirect' ) );
add_filter( 'pre_get_document_title', array( $this, 'page_template_title' ) );
}
/**
* Returns the template slug.
*
* @return string
*/
abstract public static function get_slug();
/**
* Returns the page object assigned to this template/page.
*
* @return \WP_Post|null Post object or null.
*/
abstract public static function get_placeholder_page();
/**
* Should return the title of the page.
*
* @return string
*/
abstract public static function get_template_title();
/**
* Should return true on pages/endpoints/routes where the template should be shown.
*
* @return boolean
*/
abstract protected function is_active_template();
/**
* Returns the URL to edit the template.
*
* @return string
*/
protected function get_edit_template_url() {
return admin_url( 'site-editor.php?postType=wp_template&postId=woocommerce%2Fwoocommerce%2F%2F' . $this->get_slug() );
}
/**
* When the page should be displaying the template, add it to the hierarchy.
*
* This places the template name e.g. `cart`, at the beginning of the template hierarchy array. The hook priority
* is 1 to ensure it runs first; other consumers e.g. extensions, could therefore inject their own template instead
* of this one when using the default priority of 10.
*
* @param array $templates Templates that match the pages_template_hierarchy.
*/
public function page_template_hierarchy( $templates ) {
if ( $this->is_active_template() ) {
array_unshift( $templates, $this->get_slug() );
}
return $templates;
}
/**
* Redirect the edit page screen to the template editor.
*
* @param \WP_Screen $current_screen Current screen information.
*/
public function page_template_editor_redirect( \WP_Screen $current_screen ) {
$page = $this->get_placeholder_page();
$edit_page_id = 'page' === $current_screen->id && ! empty( $_GET['post'] ) ? absint( $_GET['post'] ) : 0; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( $page && $edit_page_id === $page->ID ) {
wp_safe_redirect( $this->get_edit_template_url() );
exit;
}
}
/**
* Filter the page title when the template is active.
*
* @param string $title Page title.
* @return string
*/
public function page_template_title( $title ) {
if ( $this->is_active_template() ) {
return $this->get_template_title();
}
return $title;
}
}

1
plugins/woocommerce-blocks/src/Templates/ArchiveProductTemplatesCompatibility.php
View File

@ -63,7 +63,6 @@ class ArchiveProductTemplatesCompatibility extends AbstractTemplateCompatibility
if ( ! $this->is_archive_template() ) {
return $block_content;
}
/**
* If the block is not inherited, we don't need to inject hooks.
*/

46
plugins/woocommerce-blocks/src/Templates/CartTemplate.php Normal file
View File

@ -0,0 +1,46 @@
<?php
namespace Automattic\WooCommerce\Blocks\Templates;
/**
* CartTemplate class.
*
* @internal
*/
class CartTemplate extends AbstractPageTemplate {
/**
* Template slug.
*
* @return string
*/
public static function get_slug() {
return 'cart';
}
/**
* Returns the page object assigned to this template/page.
*
* @return \WP_Post|null Post object or null.
*/
public static function get_placeholder_page() {
$page_id = wc_get_page_id( 'cart' );
return $page_id ? get_post( $page_id ) : null;
}
/**
* True when viewing the cart page or cart endpoint.
*
* @return boolean
*/
protected function is_active_template() {
return is_cart();
}
/**
* Should return the title of the page.
*
* @return string
*/
public static function get_template_title() {
return __( 'Cart', 'woo-gutenberg-products-block' );
}
}

13
plugins/woocommerce-blocks/src/Templates/CheckoutHeaderTemplate.php Normal file
View File

@ -0,0 +1,13 @@
<?php
namespace Automattic\WooCommerce\Blocks\Templates;
/**
* CheckoutHeader Template class.
*
* @internal
*/
class CheckoutHeaderTemplate {
const SLUG = 'checkout-header';
}

46
plugins/woocommerce-blocks/src/Templates/CheckoutTemplate.php Normal file
View File

@ -0,0 +1,46 @@
<?php
namespace Automattic\WooCommerce\Blocks\Templates;
/**
* CheckoutTemplate class.
*
* @internal
*/
class CheckoutTemplate extends AbstractPageTemplate {
/**
* Template slug.
*
* @return string
*/
public static function get_slug() {
return 'checkout';
}
/**
* Returns the page object assigned to this template/page.
*
* @return \WP_Post|null Post object or null.
*/
public static function get_placeholder_page() {
$page_id = wc_get_page_id( 'checkout' );
return $page_id ? get_post( $page_id ) : null;
}
/**
* Should return the title of the page.
*
* @return string
*/
public static function get_template_title() {
return __( 'Checkout', 'woo-gutenberg-products-block' );
}
/**
* True when viewing the cart page or cart endpoint.
*
* @return boolean
*/
public function is_active_template() {
return is_checkout();
}
}

45
plugins/woocommerce-blocks/src/Templates/OrderConfirmationTemplate.php Normal file
View File

@ -0,0 +1,45 @@
<?php
namespace Automattic\WooCommerce\Blocks\Templates;
/**
* OrderConfirmationTemplate class.
*
* @internal
*/
class OrderConfirmationTemplate extends AbstractPageTemplate {
/**
* Template slug.
*
* @return string
*/
public static function get_slug() {
return 'order-confirmation';
}
/**
* Returns the page object assigned to this template/page.
*
* @return \WP_Post|null Post object or null.
*/
public static function get_placeholder_page() {
return null;
}
/**
* True when viewing the cart page or cart endpoint.
*
* @return boolean
*/
protected function is_active_template() {
return is_wc_endpoint_url( 'order-received' );
}
/**
* Should return the title of the page.
*
* @return string
*/
public static function get_template_title() {
return __( 'Order Confirmation', 'woo-gutenberg-products-block' );
}
}

42
plugins/woocommerce-blocks/src/Utils/BlockTemplateUtils.php
View File

@ -1,11 +1,15 @@
<?php
namespace Automattic\WooCommerce\Blocks\Utils;
use Automattic\WooCommerce\Blocks\Templates\ProductAttributeTemplate;
use Automattic\WooCommerce\Blocks\Templates\ProductSearchResultsTemplate;
use Automattic\WooCommerce\Blocks\Domain\Services\FeatureGating;
use Automattic\WooCommerce\Blocks\Options;
use Automattic\WooCommerce\Blocks\Templates\CartTemplate;
use Automattic\WooCommerce\Blocks\Templates\CheckoutHeaderTemplate;
use Automattic\WooCommerce\Blocks\Templates\CheckoutTemplate;
use Automattic\WooCommerce\Blocks\Templates\MiniCartTemplate;
use Automattic\WooCommerce\Blocks\Templates\OrderConfirmationTemplate;
use Automattic\WooCommerce\Blocks\Templates\ProductAttributeTemplate;
use Automattic\WooCommerce\Blocks\Templates\ProductSearchResultsTemplate;
/**
* Utility methods used for serving block templates from WooCommerce Blocks.
@ -302,38 +306,52 @@ class BlockTemplateUtils {
* @return array The plugin template types.
*/
public static function get_plugin_block_template_types() {
$plugin_template_types = array(
'single-product' => array(
return array(
'single-product' => array(
'title' => _x( 'Single Product', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'Displays a single product.', 'woo-gutenberg-products-block' ),
),
'archive-product' => array(
'archive-product' => array(
'title' => _x( 'Product Catalog', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'Displays your products.', 'woo-gutenberg-products-block' ),
),
'taxonomy-product_cat' => array(
'taxonomy-product_cat' => array(
'title' => _x( 'Products by Category', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'Displays products filtered by a category.', 'woo-gutenberg-products-block' ),
),
'taxonomy-product_tag' => array(
'taxonomy-product_tag' => array(
'title' => _x( 'Products by Tag', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'Displays products filtered by a tag.', 'woo-gutenberg-products-block' ),
),
ProductAttributeTemplate::SLUG => array(
ProductAttributeTemplate::SLUG => array(
'title' => _x( 'Products by Attribute', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'Displays products filtered by an attribute.', 'woo-gutenberg-products-block' ),
),
ProductSearchResultsTemplate::SLUG => array(
ProductSearchResultsTemplate::SLUG => array(
'title' => _x( 'Product Search Results', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'Displays search results for your store.', 'woo-gutenberg-products-block' ),
),
MiniCartTemplate::SLUG => array(
MiniCartTemplate::SLUG => array(
'title' => _x( 'Mini-Cart', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'Template used to display the Mini-Cart drawer.', 'woo-gutenberg-products-block' ),
),
CartTemplate::get_slug() => array(
'title' => _x( 'Cart', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'The Cart template displays the items selected by the user for purchase, including quantities, prices, and discounts. It allows users to review their choices before proceeding to checkout.', 'woo-gutenberg-products-block' ),
),
CheckoutTemplate::get_slug() => array(
'title' => _x( 'Checkout', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'The Checkout template guides users through the final steps of the purchase process. It enables users to enter shipping and billing information, select a payment method, and review order details.', 'woo-gutenberg-products-block' ),
),
CheckoutHeaderTemplate::SLUG => array(
'title' => _x( 'Checkout Header', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'Template used to display the simplified Checkout header.', 'woo-gutenberg-products-block' ),
),
OrderConfirmationTemplate::get_slug() => array(
'title' => _x( 'Order Confirmation', 'Template name', 'woo-gutenberg-products-block' ),
'description' => __( 'The Order Confirmation template provides customers with a summary of their completed purchase, including ordered items, shipping details, and order total. It serves as a receipt and confirmation of the successful transaction.', 'woo-gutenberg-products-block' ),
),
);
return $plugin_template_types;
}
/**

46
plugins/woocommerce-blocks/src/Utils/SettingsUtils.php Normal file
View File

@ -0,0 +1,46 @@
<?php
namespace Automattic\WooCommerce\Blocks\Utils;
use WC_Admin_Settings;
/**
* WooSettingsUtils class
*/
class SettingsUtils {
/**
* Input field for permalink settings/pages.
*
* @param array $value Input value.
*/
public static function permalink_input_field( $value ) {
$field_description = WC_Admin_Settings::get_field_description( $value );
$description = $field_description['description'];
$tooltip_html = $field_description['tooltip_html'];
?>
<tr valign="top">
<th scope="row" class="titledesc">
<label for="<?php echo esc_attr( $value['id'] ); ?>"><?php echo esc_html( $value['title'] ); ?> <?php echo wp_kses_post( $tooltip_html ); ?></label>
</th>
<td class="forminp forminp-text">
<span class="code" style="width: 400px; display:flex; align-items:center; gap:5px;">
<code class="permalink-custom" style="vertical-align: middle;">
<?php echo esc_html( get_site_url( null, '/' ) ); ?>
</code>
<input
name="<?php echo esc_attr( $value['field_name'] ); ?>"
id="<?php echo esc_attr( $value['id'] ); ?>"
type="text"
required
style="vertical-align: middle;"
value="<?php echo esc_attr( $value['value'] ); ?>"
class="<?php echo esc_attr( $value['class'] ); ?>"
placeholder="<?php echo esc_attr( $value['placeholder'] ); ?>"
/><?php echo esc_html( $value['suffix'] ); ?>
</span>
<?php echo wp_kses_post( $description ); ?>
</td>
</tr>
<?php
}
}

7
plugins/woocommerce-blocks/templates/parts/checkout-header.html Normal file
View File

@ -0,0 +1,7 @@
<!-- wp:group {"layout":{"type":"constrained"}} -->
<div class="wp-block-group">
<!-- wp:group {"align":"wide","style":{"spacing":{"padding":{"bottom":"var:preset|spacing|40"}}},"layout":{"type":"flex","justifyContent":"space-between"}} -->
<div class="wp-block-group alignwide" style="padding-bottom:var(--wp--preset--spacing--40)">
<!-- wp:site-title {"level":0} /--></div>
<!-- /wp:group --></div>
<!-- /wp:group -->

2
plugins/woocommerce-blocks/templates/templates/blockified/archive-product.html
View File

@ -39,4 +39,4 @@
</div>
<!-- /wp:group -->
<!-- wp:template-part {"slug":"footer"} /-->
<!-- wp:template-part {"slug":"footer"} /-->

164
plugins/woocommerce-blocks/templates/templates/blockified/cart.html Normal file
View File

@ -0,0 +1,164 @@
<!-- wp:template-part {"slug":"header","tagName":"header"} /-->
<!-- wp:group {"layout":{"inherit":true,"type":"constrained"}} -->
<div class="wp-block-group"><!-- wp:woocommerce/cart -->
<div class="wp-block-woocommerce-cart alignwide is-loading">
<!-- wp:woocommerce/filled-cart-block {"align":"wide"} -->
<div class="wp-block-woocommerce-filled-cart-block alignwide">
<!-- wp:woocommerce/cart-items-block -->
<div class="wp-block-woocommerce-cart-items-block">
<!-- wp:woocommerce/cart-line-items-block -->
<div class="wp-block-woocommerce-cart-line-items-block"></div>
<!-- /wp:woocommerce/cart-line-items-block -->
<!-- wp:woocommerce/cart-cross-sells-block -->
<div class="wp-block-woocommerce-cart-cross-sells-block">
<!-- wp:pattern {"slug":"woocommerce/cart-cross-sells-message"} /-->
<!-- wp:woocommerce/cart-cross-sells-products-block -->
<div class="wp-block-woocommerce-cart-cross-sells-products-block"></div>
<!-- /wp:woocommerce/cart-cross-sells-products-block -->
</div>
<!-- /wp:woocommerce/cart-cross-sells-block -->
</div>
<!-- /wp:woocommerce/cart-items-block -->
<!-- wp:woocommerce/cart-totals-block -->
<div class="wp-block-woocommerce-cart-totals-block">
<!-- wp:woocommerce/cart-order-summary-block -->
<div class="wp-block-woocommerce-cart-order-summary-block">
<!-- wp:woocommerce/cart-order-summary-heading-block -->
<div class="wp-block-woocommerce-cart-order-summary-heading-block"></div>
<!-- /wp:woocommerce/cart-order-summary-heading-block -->
<!-- wp:woocommerce/cart-order-summary-coupon-form-block -->
<div class="wp-block-woocommerce-cart-order-summary-coupon-form-block"></div>
<!-- /wp:woocommerce/cart-order-summary-coupon-form-block -->
<!-- wp:woocommerce/cart-order-summary-subtotal-block -->
<div class="wp-block-woocommerce-cart-order-summary-subtotal-block"></div>
<!-- /wp:woocommerce/cart-order-summary-subtotal-block -->
<!-- wp:woocommerce/cart-order-summary-fee-block -->
<div class="wp-block-woocommerce-cart-order-summary-fee-block"></div>
<!-- /wp:woocommerce/cart-order-summary-fee-block -->
<!-- wp:woocommerce/cart-order-summary-discount-block -->
<div class="wp-block-woocommerce-cart-order-summary-discount-block"></div>
<!-- /wp:woocommerce/cart-order-summary-discount-block -->
<!-- wp:woocommerce/cart-order-summary-shipping-block -->
<div class="wp-block-woocommerce-cart-order-summary-shipping-block"></div>
<!-- /wp:woocommerce/cart-order-summary-shipping-block -->
<!-- wp:woocommerce/cart-order-summary-taxes-block -->
<div class="wp-block-woocommerce-cart-order-summary-taxes-block"></div>
<!-- /wp:woocommerce/cart-order-summary-taxes-block -->
</div>
<!-- /wp:woocommerce/cart-order-summary-block -->
<!-- wp:woocommerce/cart-express-payment-block -->
<div class="wp-block-woocommerce-cart-express-payment-block"></div>
<!-- /wp:woocommerce/cart-express-payment-block -->
<!-- wp:woocommerce/proceed-to-checkout-block -->
<div class="wp-block-woocommerce-proceed-to-checkout-block"></div>
<!-- /wp:woocommerce/proceed-to-checkout-block -->
<!-- wp:woocommerce/cart-accepted-payment-methods-block -->
<div class="wp-block-woocommerce-cart-accepted-payment-methods-block"></div>
<!-- /wp:woocommerce/cart-accepted-payment-methods-block -->
</div>
<!-- /wp:woocommerce/cart-totals-block -->
</div>
<!-- /wp:woocommerce/filled-cart-block -->
<!-- wp:woocommerce/empty-cart-block {"align":"wide"} -->
<div class="wp-block-woocommerce-empty-cart-block alignwide">
<!-- wp:woocommerce/filled-cart-block -->
<div class="wp-block-woocommerce-filled-cart-block">
<!-- wp:woocommerce/cart-items-block -->
<div class="wp-block-woocommerce-cart-items-block">
<!-- wp:woocommerce/cart-line-items-block -->
<div class="wp-block-woocommerce-cart-line-items-block"></div>
<!-- /wp:woocommerce/cart-line-items-block -->
<!-- wp:woocommerce/cart-cross-sells-block -->
<div class="wp-block-woocommerce-cart-cross-sells-block">
<!-- wp:pattern {"slug":"woocommerce/cart-cross-sells-message"} /-->
<!-- wp:woocommerce/cart-cross-sells-products-block -->
<div class="wp-block-woocommerce-cart-cross-sells-products-block"></div>
<!-- /wp:woocommerce/cart-cross-sells-products-block -->
</div>
<!-- /wp:woocommerce/cart-cross-sells-block -->
</div>
<!-- /wp:woocommerce/cart-items-block -->
<!-- wp:woocommerce/cart-totals-block -->
<div class="wp-block-woocommerce-cart-totals-block">
<!-- wp:woocommerce/cart-order-summary-block -->
<div class="wp-block-woocommerce-cart-order-summary-block">
<!-- wp:woocommerce/cart-order-summary-heading-block -->
<div class="wp-block-woocommerce-cart-order-summary-heading-block"></div>
<!-- /wp:woocommerce/cart-order-summary-heading-block -->
<!-- wp:woocommerce/cart-order-summary-coupon-form-block -->
<div class="wp-block-woocommerce-cart-order-summary-coupon-form-block">
</div>
<!-- /wp:woocommerce/cart-order-summary-coupon-form-block -->
<!-- wp:woocommerce/cart-order-summary-subtotal-block -->
<div class="wp-block-woocommerce-cart-order-summary-subtotal-block"></div>
<!-- /wp:woocommerce/cart-order-summary-subtotal-block -->
<!-- wp:woocommerce/cart-order-summary-fee-block -->
<div class="wp-block-woocommerce-cart-order-summary-fee-block"></div>
<!-- /wp:woocommerce/cart-order-summary-fee-block -->
<!-- wp:woocommerce/cart-order-summary-discount-block -->
<div class="wp-block-woocommerce-cart-order-summary-discount-block"></div>
<!-- /wp:woocommerce/cart-order-summary-discount-block -->
<!-- wp:woocommerce/cart-order-summary-shipping-block -->
<div class="wp-block-woocommerce-cart-order-summary-shipping-block"></div>
<!-- /wp:woocommerce/cart-order-summary-shipping-block -->
<!-- wp:woocommerce/cart-order-summary-taxes-block -->
<div class="wp-block-woocommerce-cart-order-summary-taxes-block"></div>
<!-- /wp:woocommerce/cart-order-summary-taxes-block -->
</div>
<!-- /wp:woocommerce/cart-order-summary-block -->
<!-- wp:woocommerce/cart-express-payment-block -->
<div class="wp-block-woocommerce-cart-express-payment-block"></div>
<!-- /wp:woocommerce/cart-express-payment-block -->
<!-- wp:woocommerce/proceed-to-checkout-block -->
<div class="wp-block-woocommerce-proceed-to-checkout-block"></div>
<!-- /wp:woocommerce/proceed-to-checkout-block -->
<!-- wp:woocommerce/cart-accepted-payment-methods-block -->
<div class="wp-block-woocommerce-cart-accepted-payment-methods-block"></div>
<!-- /wp:woocommerce/cart-accepted-payment-methods-block -->
</div>
<!-- /wp:woocommerce/cart-totals-block -->
</div>
<!-- /wp:woocommerce/filled-cart-block -->
<!-- wp:woocommerce/empty-cart-block -->
<div class="wp-block-woocommerce-empty-cart-block">
<!-- wp:pattern {"slug":"woocommerce/cart-empty-message"} /-->
<!-- wp:separator {"className":"is-style-dots"} -->
<hr class="wp-block-separator has-alpha-channel-opacity is-style-dots" />
<!-- /wp:separator -->
<!-- wp:pattern {"slug":"woocommerce/cart-new-in-store-message"} /-->
<!-- wp:woocommerce/product-new {"rows":1} /-->
</div>
<!-- /wp:woocommerce/empty-cart-block -->
</div>
<!-- /wp:woocommerce/empty-cart-block -->
</div>
<!-- /wp:woocommerce/cart -->
</div>
<!-- /wp:group -->
<!-- wp:template-part {"slug":"footer"} /-->

82
plugins/woocommerce-blocks/templates/templates/blockified/checkout.html Normal file
View File

@ -0,0 +1,82 @@
<!-- wp:template-part {"slug":"checkout-header","theme":"woocommerce/woocommerce"} /-->
<!-- wp:group {"layout":{"inherit":true,"type":"constrained"}} -->
<div class="wp-block-group"><!-- wp:woocommerce/checkout {"className":"wc-block-checkout"} -->
<div class="wp-block-woocommerce-checkout alignwide wc-block-checkout is-loading"><!-- wp:woocommerce/checkout-fields-block -->
<div class="wp-block-woocommerce-checkout-fields-block"><!-- wp:woocommerce/checkout-express-payment-block -->
<div class="wp-block-woocommerce-checkout-express-payment-block"></div>
<!-- /wp:woocommerce/checkout-express-payment-block -->
<!-- wp:woocommerce/checkout-contact-information-block -->
<div class="wp-block-woocommerce-checkout-contact-information-block"></div>
<!-- /wp:woocommerce/checkout-contact-information-block -->
<!-- wp:woocommerce/checkout-shipping-method-block -->
<div class="wp-block-woocommerce-checkout-shipping-method-block"></div>
<!-- /wp:woocommerce/checkout-shipping-method-block -->
<!-- wp:woocommerce/checkout-pickup-options-block -->
<div class="wp-block-woocommerce-checkout-pickup-options-block"></div>
<!-- /wp:woocommerce/checkout-pickup-options-block -->
<!-- wp:woocommerce/checkout-shipping-address-block -->
<div class="wp-block-woocommerce-checkout-shipping-address-block"></div>
<!-- /wp:woocommerce/checkout-shipping-address-block -->
<!-- wp:woocommerce/checkout-billing-address-block -->
<div class="wp-block-woocommerce-checkout-billing-address-block"></div>
<!-- /wp:woocommerce/checkout-billing-address-block -->
<!-- wp:woocommerce/checkout-shipping-methods-block -->
<div class="wp-block-woocommerce-checkout-shipping-methods-block"></div>
<!-- /wp:woocommerce/checkout-shipping-methods-block -->
<!-- wp:woocommerce/checkout-payment-block -->
<div class="wp-block-woocommerce-checkout-payment-block"></div>
<!-- /wp:woocommerce/checkout-payment-block -->
<!-- wp:woocommerce/checkout-order-note-block -->
<div class="wp-block-woocommerce-checkout-order-note-block"></div>
<!-- /wp:woocommerce/checkout-order-note-block -->
<!-- wp:woocommerce/checkout-terms-block -->
<div class="wp-block-woocommerce-checkout-terms-block"></div>
<!-- /wp:woocommerce/checkout-terms-block -->
<!-- wp:woocommerce/checkout-actions-block -->
<div class="wp-block-woocommerce-checkout-actions-block"></div>
<!-- /wp:woocommerce/checkout-actions-block --></div>
<!-- /wp:woocommerce/checkout-fields-block -->
<!-- wp:woocommerce/checkout-totals-block -->
<div class="wp-block-woocommerce-checkout-totals-block"><!-- wp:woocommerce/checkout-order-summary-block -->
<div class="wp-block-woocommerce-checkout-order-summary-block"><!-- wp:woocommerce/checkout-order-summary-cart-items-block -->
<div class="wp-block-woocommerce-checkout-order-summary-cart-items-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-cart-items-block -->
<!-- wp:woocommerce/checkout-order-summary-coupon-form-block -->
<div class="wp-block-woocommerce-checkout-order-summary-coupon-form-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-coupon-form-block -->
<!-- wp:woocommerce/checkout-order-summary-subtotal-block -->
<div class="wp-block-woocommerce-checkout-order-summary-subtotal-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-subtotal-block -->
<!-- wp:woocommerce/checkout-order-summary-fee-block -->
<div class="wp-block-woocommerce-checkout-order-summary-fee-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-fee-block -->
<!-- wp:woocommerce/checkout-order-summary-discount-block -->
<div class="wp-block-woocommerce-checkout-order-summary-discount-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-discount-block -->
<!-- wp:woocommerce/checkout-order-summary-shipping-block -->
<div class="wp-block-woocommerce-checkout-order-summary-shipping-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-shipping-block -->
<!-- wp:woocommerce/checkout-order-summary-taxes-block -->
<div class="wp-block-woocommerce-checkout-order-summary-taxes-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-taxes-block --></div>
<!-- /wp:woocommerce/checkout-order-summary-block --></div>
<!-- /wp:woocommerce/checkout-totals-block --></div>
<!-- /wp:woocommerce/checkout --></div>
<!-- /wp:group -->

7
plugins/woocommerce-blocks/templates/templates/blockified/order-confirmation.html Normal file
View File

@ -0,0 +1,7 @@
<!-- wp:template-part {"slug":"header"} /-->
<!-- wp:group {"tagName": "main", "layout":{"inherit":true,"type":"constrained"}} -->
<main class="wp-block-group">
<!-- wp:woocommerce/legacy-template {"template":"order-confirmation"} /-->
</main>
<!-- /wp:group -->
<!-- wp:template-part {"slug":"footer"} /-->

2
plugins/woocommerce-blocks/templates/templates/blockified/product-search-results.html
View File

@ -38,4 +38,4 @@
</div>
<!-- /wp:group -->
<!-- wp:template-part {"slug":"footer"} /-->
<!-- wp:template-part {"slug":"footer"} /-->

164
plugins/woocommerce-blocks/templates/templates/cart.html Normal file
View File

@ -0,0 +1,164 @@
<!-- wp:template-part {"slug":"header","tagName":"header"} /-->
<!-- wp:group {"layout":{"inherit":true,"type":"constrained"}} -->
<div class="wp-block-group"><!-- wp:woocommerce/cart -->
<div class="wp-block-woocommerce-cart alignwide is-loading">
<!-- wp:woocommerce/filled-cart-block {"align":"wide"} -->
<div class="wp-block-woocommerce-filled-cart-block alignwide">
<!-- wp:woocommerce/cart-items-block -->
<div class="wp-block-woocommerce-cart-items-block">
<!-- wp:woocommerce/cart-line-items-block -->
<div class="wp-block-woocommerce-cart-line-items-block"></div>
<!-- /wp:woocommerce/cart-line-items-block -->
<!-- wp:woocommerce/cart-cross-sells-block -->
<div class="wp-block-woocommerce-cart-cross-sells-block">
<!-- wp:pattern {"slug":"woocommerce/cart-cross-sells-message"} /-->
<!-- wp:woocommerce/cart-cross-sells-products-block -->
<div class="wp-block-woocommerce-cart-cross-sells-products-block"></div>
<!-- /wp:woocommerce/cart-cross-sells-products-block -->
</div>
<!-- /wp:woocommerce/cart-cross-sells-block -->
</div>
<!-- /wp:woocommerce/cart-items-block -->
<!-- wp:woocommerce/cart-totals-block -->
<div class="wp-block-woocommerce-cart-totals-block">
<!-- wp:woocommerce/cart-order-summary-block -->
<div class="wp-block-woocommerce-cart-order-summary-block">
<!-- wp:woocommerce/cart-order-summary-heading-block -->
<div class="wp-block-woocommerce-cart-order-summary-heading-block"></div>
<!-- /wp:woocommerce/cart-order-summary-heading-block -->
<!-- wp:woocommerce/cart-order-summary-coupon-form-block -->
<div class="wp-block-woocommerce-cart-order-summary-coupon-form-block"></div>
<!-- /wp:woocommerce/cart-order-summary-coupon-form-block -->
<!-- wp:woocommerce/cart-order-summary-subtotal-block -->
<div class="wp-block-woocommerce-cart-order-summary-subtotal-block"></div>
<!-- /wp:woocommerce/cart-order-summary-subtotal-block -->
<!-- wp:woocommerce/cart-order-summary-fee-block -->
<div class="wp-block-woocommerce-cart-order-summary-fee-block"></div>
<!-- /wp:woocommerce/cart-order-summary-fee-block -->
<!-- wp:woocommerce/cart-order-summary-discount-block -->
<div class="wp-block-woocommerce-cart-order-summary-discount-block"></div>
<!-- /wp:woocommerce/cart-order-summary-discount-block -->
<!-- wp:woocommerce/cart-order-summary-shipping-block -->
<div class="wp-block-woocommerce-cart-order-summary-shipping-block"></div>
<!-- /wp:woocommerce/cart-order-summary-shipping-block -->
<!-- wp:woocommerce/cart-order-summary-taxes-block -->
<div class="wp-block-woocommerce-cart-order-summary-taxes-block"></div>
<!-- /wp:woocommerce/cart-order-summary-taxes-block -->
</div>
<!-- /wp:woocommerce/cart-order-summary-block -->
<!-- wp:woocommerce/cart-express-payment-block -->
<div class="wp-block-woocommerce-cart-express-payment-block"></div>
<!-- /wp:woocommerce/cart-express-payment-block -->
<!-- wp:woocommerce/proceed-to-checkout-block -->
<div class="wp-block-woocommerce-proceed-to-checkout-block"></div>
<!-- /wp:woocommerce/proceed-to-checkout-block -->
<!-- wp:woocommerce/cart-accepted-payment-methods-block -->
<div class="wp-block-woocommerce-cart-accepted-payment-methods-block"></div>
<!-- /wp:woocommerce/cart-accepted-payment-methods-block -->
</div>
<!-- /wp:woocommerce/cart-totals-block -->
</div>
<!-- /wp:woocommerce/filled-cart-block -->
<!-- wp:woocommerce/empty-cart-block {"align":"wide"} -->
<div class="wp-block-woocommerce-empty-cart-block alignwide">
<!-- wp:woocommerce/filled-cart-block -->
<div class="wp-block-woocommerce-filled-cart-block">
<!-- wp:woocommerce/cart-items-block -->
<div class="wp-block-woocommerce-cart-items-block">
<!-- wp:woocommerce/cart-line-items-block -->
<div class="wp-block-woocommerce-cart-line-items-block"></div>
<!-- /wp:woocommerce/cart-line-items-block -->
<!-- wp:woocommerce/cart-cross-sells-block -->
<div class="wp-block-woocommerce-cart-cross-sells-block">
<!-- wp:pattern {"slug":"woocommerce/cart-cross-sells-message"} /-->
<!-- wp:woocommerce/cart-cross-sells-products-block -->
<div class="wp-block-woocommerce-cart-cross-sells-products-block"></div>
<!-- /wp:woocommerce/cart-cross-sells-products-block -->
</div>
<!-- /wp:woocommerce/cart-cross-sells-block -->
</div>
<!-- /wp:woocommerce/cart-items-block -->
<!-- wp:woocommerce/cart-totals-block -->
<div class="wp-block-woocommerce-cart-totals-block">
<!-- wp:woocommerce/cart-order-summary-block -->
<div class="wp-block-woocommerce-cart-order-summary-block">
<!-- wp:woocommerce/cart-order-summary-heading-block -->
<div class="wp-block-woocommerce-cart-order-summary-heading-block"></div>
<!-- /wp:woocommerce/cart-order-summary-heading-block -->
<!-- wp:woocommerce/cart-order-summary-coupon-form-block -->
<div class="wp-block-woocommerce-cart-order-summary-coupon-form-block">
</div>
<!-- /wp:woocommerce/cart-order-summary-coupon-form-block -->
<!-- wp:woocommerce/cart-order-summary-subtotal-block -->
<div class="wp-block-woocommerce-cart-order-summary-subtotal-block"></div>
<!-- /wp:woocommerce/cart-order-summary-subtotal-block -->
<!-- wp:woocommerce/cart-order-summary-fee-block -->
<div class="wp-block-woocommerce-cart-order-summary-fee-block"></div>
<!-- /wp:woocommerce/cart-order-summary-fee-block -->
<!-- wp:woocommerce/cart-order-summary-discount-block -->
<div class="wp-block-woocommerce-cart-order-summary-discount-block"></div>
<!-- /wp:woocommerce/cart-order-summary-discount-block -->
<!-- wp:woocommerce/cart-order-summary-shipping-block -->
<div class="wp-block-woocommerce-cart-order-summary-shipping-block"></div>
<!-- /wp:woocommerce/cart-order-summary-shipping-block -->
<!-- wp:woocommerce/cart-order-summary-taxes-block -->
<div class="wp-block-woocommerce-cart-order-summary-taxes-block"></div>
<!-- /wp:woocommerce/cart-order-summary-taxes-block -->
</div>
<!-- /wp:woocommerce/cart-order-summary-block -->
<!-- wp:woocommerce/cart-express-payment-block -->
<div class="wp-block-woocommerce-cart-express-payment-block"></div>
<!-- /wp:woocommerce/cart-express-payment-block -->
<!-- wp:woocommerce/proceed-to-checkout-block -->
<div class="wp-block-woocommerce-proceed-to-checkout-block"></div>
<!-- /wp:woocommerce/proceed-to-checkout-block -->
<!-- wp:woocommerce/cart-accepted-payment-methods-block -->
<div class="wp-block-woocommerce-cart-accepted-payment-methods-block"></div>
<!-- /wp:woocommerce/cart-accepted-payment-methods-block -->
</div>
<!-- /wp:woocommerce/cart-totals-block -->
</div>
<!-- /wp:woocommerce/filled-cart-block -->
<!-- wp:woocommerce/empty-cart-block -->
<div class="wp-block-woocommerce-empty-cart-block">
<!-- wp:pattern {"slug":"woocommerce/cart-empty-message"} /-->
<!-- wp:separator {"className":"is-style-dots"} -->
<hr class="wp-block-separator has-alpha-channel-opacity is-style-dots" />
<!-- /wp:separator -->
<!-- wp:pattern {"slug":"woocommerce/cart-new-in-store-message"} /-->
<!-- wp:woocommerce/product-new {"rows":1} /-->
</div>
<!-- /wp:woocommerce/empty-cart-block -->
</div>
<!-- /wp:woocommerce/empty-cart-block -->
</div>
<!-- /wp:woocommerce/cart -->
</div>
<!-- /wp:group -->
<!-- wp:template-part {"slug":"footer"} /-->

82
plugins/woocommerce-blocks/templates/templates/checkout.html Normal file
View File

@ -0,0 +1,82 @@
<!-- wp:template-part {"slug":"checkout-header","theme":"woocommerce/woocommerce"} /-->
<!-- wp:group {"layout":{"inherit":true,"type":"constrained"}} -->
<div class="wp-block-group"><!-- wp:woocommerce/checkout {"className":"wc-block-checkout"} -->
<div class="wp-block-woocommerce-checkout alignwide wc-block-checkout is-loading"><!-- wp:woocommerce/checkout-fields-block -->
<div class="wp-block-woocommerce-checkout-fields-block"><!-- wp:woocommerce/checkout-express-payment-block -->
<div class="wp-block-woocommerce-checkout-express-payment-block"></div>
<!-- /wp:woocommerce/checkout-express-payment-block -->
<!-- wp:woocommerce/checkout-contact-information-block -->
<div class="wp-block-woocommerce-checkout-contact-information-block"></div>
<!-- /wp:woocommerce/checkout-contact-information-block -->
<!-- wp:woocommerce/checkout-shipping-method-block -->
<div class="wp-block-woocommerce-checkout-shipping-method-block"></div>
<!-- /wp:woocommerce/checkout-shipping-method-block -->
<!-- wp:woocommerce/checkout-pickup-options-block -->
<div class="wp-block-woocommerce-checkout-pickup-options-block"></div>
<!-- /wp:woocommerce/checkout-pickup-options-block -->
<!-- wp:woocommerce/checkout-shipping-address-block -->
<div class="wp-block-woocommerce-checkout-shipping-address-block"></div>
<!-- /wp:woocommerce/checkout-shipping-address-block -->
<!-- wp:woocommerce/checkout-billing-address-block -->
<div class="wp-block-woocommerce-checkout-billing-address-block"></div>
<!-- /wp:woocommerce/checkout-billing-address-block -->
<!-- wp:woocommerce/checkout-shipping-methods-block -->
<div class="wp-block-woocommerce-checkout-shipping-methods-block"></div>
<!-- /wp:woocommerce/checkout-shipping-methods-block -->
<!-- wp:woocommerce/checkout-payment-block -->
<div class="wp-block-woocommerce-checkout-payment-block"></div>
<!-- /wp:woocommerce/checkout-payment-block -->
<!-- wp:woocommerce/checkout-order-note-block -->
<div class="wp-block-woocommerce-checkout-order-note-block"></div>
<!-- /wp:woocommerce/checkout-order-note-block -->
<!-- wp:woocommerce/checkout-terms-block -->
<div class="wp-block-woocommerce-checkout-terms-block"></div>
<!-- /wp:woocommerce/checkout-terms-block -->
<!-- wp:woocommerce/checkout-actions-block -->
<div class="wp-block-woocommerce-checkout-actions-block"></div>
<!-- /wp:woocommerce/checkout-actions-block --></div>
<!-- /wp:woocommerce/checkout-fields-block -->
<!-- wp:woocommerce/checkout-totals-block -->
<div class="wp-block-woocommerce-checkout-totals-block"><!-- wp:woocommerce/checkout-order-summary-block -->
<div class="wp-block-woocommerce-checkout-order-summary-block"><!-- wp:woocommerce/checkout-order-summary-cart-items-block -->
<div class="wp-block-woocommerce-checkout-order-summary-cart-items-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-cart-items-block -->
<!-- wp:woocommerce/checkout-order-summary-coupon-form-block -->
<div class="wp-block-woocommerce-checkout-order-summary-coupon-form-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-coupon-form-block -->
<!-- wp:woocommerce/checkout-order-summary-subtotal-block -->
<div class="wp-block-woocommerce-checkout-order-summary-subtotal-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-subtotal-block -->
<!-- wp:woocommerce/checkout-order-summary-fee-block -->
<div class="wp-block-woocommerce-checkout-order-summary-fee-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-fee-block -->
<!-- wp:woocommerce/checkout-order-summary-discount-block -->
<div class="wp-block-woocommerce-checkout-order-summary-discount-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-discount-block -->
<!-- wp:woocommerce/checkout-order-summary-shipping-block -->
<div class="wp-block-woocommerce-checkout-order-summary-shipping-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-shipping-block -->
<!-- wp:woocommerce/checkout-order-summary-taxes-block -->
<div class="wp-block-woocommerce-checkout-order-summary-taxes-block"></div>
<!-- /wp:woocommerce/checkout-order-summary-taxes-block --></div>
<!-- /wp:woocommerce/checkout-order-summary-block --></div>
<!-- /wp:woocommerce/checkout-totals-block --></div>
<!-- /wp:woocommerce/checkout --></div>
<!-- /wp:group -->

7
plugins/woocommerce-blocks/templates/templates/order-confirmation.html Normal file
View File

@ -0,0 +1,7 @@
<!-- wp:template-part {"slug":"header"} /-->
<!-- wp:group {"tagName": "main", "layout":{"inherit":true,"type":"constrained"}} -->
<main class="wp-block-group">
<!-- wp:woocommerce/legacy-template {"template":"order-confirmation"} /-->
</main>
<!-- /wp:group -->
<!-- wp:template-part {"slug":"footer"} /-->

14
plugins/woocommerce-blocks/tests/e2e-pw/global-setup.ts
View File

@ -43,12 +43,16 @@ const loginAsCustomer = async ( config: FullConfig ) => {
const customerRetries = 5;
for ( let i = 0; i < customerRetries; i++ ) {
try {
await customerPage.goto( `/wp-admin` );
await customerPage.goto( `/wp-admin`, {
waitUntil: 'networkidle',
} );
await customerPage.fill( 'input[name="log"]', customer.username );
await customerPage.fill( 'input[name="pwd"]', customer.password );
await customerPage.click( 'text=Log In' );
await customerPage.goto( `/my-account` );
await customerPage.goto( `/my-account`, {
waitUntil: 'networkidle',
} );
await customerPage
.context()
@ -86,7 +90,7 @@ const prepareAttributes = async ( config: FullConfig ) => {
const context = await browser.newContext( contextOptions );
const page = await context.newPage();
await page.goto( `/wp-admin` );
await page.goto( `/wp-admin`, { waitUntil: 'networkidle' } );
await page.fill( 'input[name="log"]', admin.username );
await page.fill( 'input[name="pwd"]', admin.password );
await page.click( 'text=Log In' );
@ -100,7 +104,9 @@ const prepareAttributes = async ( config: FullConfig ) => {
await dialog.accept();
} );
await page.goto( '/wp-admin/admin.php?page=wc-status&tab=tools' );
await page.goto( '/wp-admin/admin.php?page=wc-status&tab=tools', {
waitUntil: 'networkidle',
} );
await page.click( '.regenerate_product_attributes_lookup_table input' );

6
plugins/woocommerce-blocks/tests/e2e-pw/tests/basic.block_theme.spec.ts
View File

@ -11,7 +11,7 @@ test.describe(
'A basic set of tests to ensure WP, wp-admin and my-account load',
async () => {
test( 'Load the home page', async ( { page } ) => {
await page.goto( '/' );
await page.goto( '/', { waitUntil: 'networkidle' } );
const title = page
.locator( 'header' )
.locator( '.wp-block-site-title' );
@ -22,7 +22,7 @@ test.describe(
test.describe( 'Sign in as admin', () => {
test( 'Load wp-admin', async ( { page } ) => {
await page.goto( '/wp-admin' );
await page.goto( '/wp-admin', { waitUntil: 'networkidle' } );
const title = page.locator( 'div.wrap > h1' );
await expect( title ).toHaveText( 'Dashboard' );
} );
@ -33,7 +33,7 @@ test.describe(
storageState: process.env.CUSTOMERSTATE,
} );
test( 'Load customer my account page', async ( { page } ) => {
await page.goto( '/my-account' );
await page.goto( '/my-account', { waitUntil: 'networkidle' } );
const title = page.locator( 'h1.wp-block-post-title' );
await expect( title ).toHaveText( 'My Account' );
} );

81
plugins/woocommerce-blocks/tests/e2e-pw/tests/classic-template/classic-template.block_theme.side_effects.spec.ts
View File

@ -4,18 +4,14 @@
import { BlockData } from '@woocommerce/e2e-types';
import { test, expect } from '@woocommerce/e2e-playwright-utils';
import { cli } from '@woocommerce/e2e-utils';
import { deleteAllTemplates } from '@wordpress/e2e-test-utils';
/**
* Internal dependencies
*/
const blockData: BlockData = {
const blockData: Partial< BlockData > = {
name: 'woocommerce/legacy-template',
mainClass: '.wc-block-price-filter',
selectors: {
frontend: {},
editor: {},
},
};
const templates = {
@ -24,12 +20,12 @@ const templates = {
slug: 'single-product',
frontendPage: '/product/single/',
},
'taxonomy-product_attribute': {
templateTitle: 'Product Attribute',
slug: 'taxonomy-product_attribute',
frontendPage: '/product-attribute/color/',
},
// This test is disabled because archives are disabled for attributes by default. This can be uncommented when this is toggled on.
//'taxonomy-product_attribute': {
// templateTitle: 'Product Attribute',
// slug: 'taxonomy-product_attribute',
// frontendPage: '/product-attribute/color/',
//},
'taxonomy-product_cat': {
templateTitle: 'Product Category',
slug: 'taxonomy-product_cat',
@ -49,69 +45,64 @@ const templates = {
'product-search-results': {
templateTitle: 'Product Search Results',
slug: 'product-search-results',
frontendPage: '/?s=single&post_type=product',
frontendPage: '/?s=s&post_type=product',
},
};
for ( const { templateTitle, slug, frontendPage } of Object.values(
templates
) ) {
test.describe( `${ blockData.name } Block `, () => {
test.beforeAll( async () => {
await cli(
'npm run wp-env run tests-cli "wp option update wc_blocks_use_blockified_product_grid_block_as_template false"'
);
} );
test.beforeAll( async () => {
await cli(
'npm run wp-env run tests-cli "wp option update wc_blocks_use_blockified_product_grid_block_as_template false"'
);
await deleteAllTemplates( 'wp_template' );
} );
test.afterAll( async () => {
await cli(
'npm run wp-env run tests-cli "wp option delete wc_blocks_use_blockified_product_grid_block_as_template"'
);
await deleteAllTemplates( 'wp_template' );
} );
for ( const { templateTitle, slug } of Object.values( templates ) ) {
test.describe( `${ blockData.name } Block `, () => {
test( `is rendered on ${ templateTitle } template`, async ( {
admin,
editorUtils,
editor,
} ) => {
await admin.visitSiteEditor( {
postId: `woocommerce/woocommerce//${ slug }`,
postType: 'wp_template',
} );
await editor.canvas.click( 'body' );
await editorUtils.enterEditMode();
const block = await editorUtils.getBlockByName( blockData.name );
expect( block ).not.toBeNull();
await expect( block ).toBeVisible();
} );
test( `is rendered on ${ templateTitle } template - frontend side`, async ( {
// These tests consistently fail due to the default content of the page--potentially the classic block is not being
// used after another test runs. Reenable this when we have a solution for this.
test.skip( `is rendered on ${ templateTitle } template - frontend side`, async ( {
admin,
editor,
editorUtils,
page,
} ) => {
await admin.visitSiteEditor( {
postId: `woocommerce/woocommerce//${ slug }`,
postType: 'wp_template',
} );
await editor.canvas.click( 'body' );
await editorUtils.enterEditMode();
await editor.insertBlock( {
name: 'core/paragraph',
attributes: { content: 'Hello World' },
} );
await editor.saveSiteEditorEntities();
await page.goto( frontendPage );
const helloWorldText = await page.getByText( 'Hello World' );
expect( helloWorldText ).not.toBeNull();
} );
test.afterAll( async ( { requestUtils } ) => {
await cli(
'npm run wp-env run tests-cli "wp option delete wc_blocks_use_blockified_product_grid_block_as_template"'
);
await requestUtils.deleteAllTemplates( 'wp_template' );
await requestUtils.deleteAllTemplates( 'wp_template_part' );
await expect(
page.getByText( 'Hello World' ).first()
).toBeVisible();
} );
} );
}

95
plugins/woocommerce-blocks/tests/e2e-pw/tests/permalink-settings/permalink-settings.block_theme.spec.ts Normal file
View File

@ -0,0 +1,95 @@
/**
* External dependencies
*/
import { test, expect } from '@woocommerce/e2e-playwright-utils';
import { cli } from '@woocommerce/e2e-utils';
/**
* Internal dependencies
*/
import { goToShop, addToCart } from '../../utils';
test.describe(
'Tests permalink settings for the cart and checkout templates',
async () => {
test.afterAll( async () => {
await cli(
'npm run wp-env run tests-cli "wp option update woocommerce_cart_page_endpoint cart"'
);
await cli(
'npm run wp-env run tests-cli "wp option update woocommerce_checkout_page_endpoint checkout"'
);
} );
test.describe( 'Settings page', () => {
test( 'Load advanced settings', async ( { page } ) => {
await page.goto(
'/wp-admin/admin.php?page=wc-settings&tab=advanced'
);
const title = page
.locator( 'div.wrap.woocommerce > form > h2' )
.first();
await expect( title ).toHaveText( 'Page setup' );
} );
test( 'Permlink settings exist', async ( { page } ) => {
await page.goto(
'/wp-admin/admin.php?page=wc-settings&tab=advanced'
);
const cartInput = page.getByLabel( 'Cart page', {
exact: true,
} );
const checkoutInput = page.getByLabel( 'Checkout page', {
exact: true,
} );
await expect( cartInput ).toBeVisible();
await expect( checkoutInput ).toBeVisible();
} );
} );
test.describe( 'Frontend templates are updated', () => {
test.beforeEach( async ( { page } ) => {
await goToShop( page );
await addToCart( page );
} );
test( 'Changing cart permalink works', async ( { page } ) => {
await page.goto(
'/wp-admin/admin.php?page=wc-settings&tab=advanced'
);
const cartInput = page.getByLabel( 'Cart page', {
exact: true,
} );
cartInput.fill( 'updated-cart-permalink' );
await page.click( 'button[name="save"]' );
await page.waitForLoadState( 'networkidle' );
// Visit the updated page.
await page.goto( '/updated-cart-permalink', {
waitUntil: 'networkidle',
} );
const cartText = await page.getByText( 'Proceed to checkout' );
expect( cartText ).toBeVisible();
} );
test( 'Changing checkout permalink works', async ( { page } ) => {
await page.goto(
'/wp-admin/admin.php?page=wc-settings&tab=advanced'
);
const checkoutInput = page.getByLabel( 'Checkout page', {
exact: true,
} );
checkoutInput.fill( 'updated-checkout-permalink' );
await page.click( 'button[name="save"]' );
await page.waitForLoadState( 'networkidle' );
// Visit the updated page.
await page.goto( '/updated-checkout-permalink', {
waitUntil: 'networkidle',
} );
const cartText = await page.getByText( 'Place Order' );
expect( cartText ).toBeVisible();
} );
} );
}
);

8
plugins/woocommerce-blocks/tests/e2e-pw/tests/price-filter/price-filter.block_theme.side_effects.spec.ts
View File

@ -3,7 +3,7 @@
*/
import { BlockData } from '@woocommerce/e2e-types';
import { test, expect } from '@woocommerce/e2e-playwright-utils';
import { BASE_URL, cli, getBlockByName } from '@woocommerce/e2e-utils';
import { BASE_URL, getBlockByName, cli } from '@woocommerce/e2e-utils';
/**
* Internal dependencies
@ -103,7 +103,7 @@ test.describe( `${ blockData.name } Block - with All products Block`, () => {
);
} );
} );
// These tests are disabled because there is an issue with the default contents of this page, possible caused by other tests.
test.describe( `${ blockData.name } Block - with PHP classic template`, () => {
test.beforeAll( async () => {
await cli(
@ -135,7 +135,7 @@ test.describe( `${ blockData.name } Block - with PHP classic template`, () => {
);
} );
test( 'should show all products', async ( { page } ) => {
test.skip( 'should show all products', async ( { page } ) => {
const legacyTemplate = await getBlockByName( {
page,
name: 'woocommerce/legacy-template',
@ -151,7 +151,7 @@ test.describe( `${ blockData.name } Block - with PHP classic template`, () => {
expect( products ).toHaveLength( 16 );
} );
test( 'should show only products that match the filter', async ( {
test.skip( 'should show only products that match the filter', async ( {
page,
pageUtils,
} ) => {

13
plugins/woocommerce-blocks/tests/e2e-pw/tests/products/products.block_theme.side_effects.spec.ts
View File

@ -22,12 +22,13 @@ const blockData: BlockData = {
};
const templates = {
'taxonomy-product_attribute': {
templateTitle: 'Product Attribute',
slug: 'taxonomy-product_attribute',
frontendPage: '/product-attribute/color/',
legacyBlockName: 'woocommerce/legacy-template',
},
// This test is disabled because archives are disabled for attributes by default. This can be uncommented when this is toggled on.
//'taxonomy-product_attribute': {
// templateTitle: 'Product Attribute',
// slug: 'taxonomy-product_attribute',
// frontendPage: '/product-attribute/color/',
// legacyBlockName: 'woocommerce/legacy-template',
//},
'taxonomy-product_cat': {
templateTitle: 'Product Category',
slug: 'taxonomy-product_cat',

53
plugins/woocommerce-blocks/tests/e2e-pw/tests/templates/cart-template.block_theme.spec.ts Normal file
View File

@ -0,0 +1,53 @@
/**
* External dependencies
*/
import { test, expect } from '@woocommerce/e2e-playwright-utils';
const permalink = '/cart';
const templatePath = 'woocommerce/woocommerce//cart';
const templateType = 'wp_template';
test.describe( 'Test the cart template', async () => {
test.afterAll( async ( { requestUtils } ) => {
await requestUtils.deleteAllTemplates( 'wp_template' );
await requestUtils.deleteAllTemplates( 'wp_template_part' );
} );
test( 'Template can be opened in the site editor', async ( {
page,
editorUtils,
} ) => {
await page.goto( '/wp-admin/site-editor.php' );
await page.getByRole( 'button', { name: /Templates/i } ).click();
await page.getByRole( 'button', { name: /Cart/i } ).click();
await editorUtils.enterEditMode();
await expect(
page
.frameLocator( 'iframe' )
.locator( 'button:has-text("Proceed to checkout")' )
.first()
).toBeVisible();
} );
test( 'Template can be modified', async ( {
page,
admin,
editor,
editorUtils,
} ) => {
await admin.visitSiteEditor( {
postId: templatePath,
postType: templateType,
} );
await editorUtils.enterEditMode();
await editor.insertBlock( {
name: 'core/paragraph',
attributes: { content: 'Hello World' },
} );
await editor.saveSiteEditorEntities();
await page.goto( permalink, { waitUntil: 'networkidle' } );
await expect( page.getByText( 'Hello World' ).first() ).toBeVisible();
} );
} );

46
plugins/woocommerce-blocks/tests/e2e-pw/tests/templates/checkout-header-template-part.block_theme.spec.ts Normal file
View File

@ -0,0 +1,46 @@
/**
* External dependencies
*/
import { test, expect } from '@woocommerce/e2e-playwright-utils';
const permalink = '/checkout';
const templatePath = 'woocommerce/woocommerce//checkout-header';
const templateType = 'wp_template_part';
test.afterAll( async ( { requestUtils } ) => {
await requestUtils.deleteAllTemplates( 'wp_template' );
await requestUtils.deleteAllTemplates( 'wp_template_part' );
} );
test.describe( 'Test the checkout header template part', async () => {
test( 'Template can be opened in the site editor', async ( { page } ) => {
await page.goto( '/wp-admin/site-editor.php' );
await page.getByRole( 'button', { name: /Template Parts/i } ).click();
await page.getByRole( 'button', { name: /Checkout Header/i } ).click();
const editButton = page.getByRole( 'button', { name: /Edit/i } );
await expect( editButton ).toBeVisible();
} );
test( 'Template can be modified', async ( {
page,
admin,
editor,
editorUtils,
} ) => {
await admin.visitSiteEditor( {
postId: templatePath,
postType: templateType,
} );
await editorUtils.enterEditMode();
await editor.insertBlock( {
name: 'core/paragraph',
attributes: { content: 'Hello World' },
} );
await editor.saveSiteEditorEntities();
await page.goto( permalink, { waitUntil: 'networkidle' } );
await expect( page.getByText( 'Hello World' ).first() ).toBeVisible();
} );
} );

53
plugins/woocommerce-blocks/tests/e2e-pw/tests/templates/checkout-template.block_theme.spec.ts Normal file
View File

@ -0,0 +1,53 @@
/**
* External dependencies
*/
import { test, expect } from '@woocommerce/e2e-playwright-utils';
const permalink = '/checkout';
const templatePath = 'woocommerce/woocommerce//checkout';
const templateType = 'wp_template';
test.describe( 'Test the checkout template', async () => {
test.afterAll( async ( { requestUtils } ) => {
await requestUtils.deleteAllTemplates( 'wp_template' );
await requestUtils.deleteAllTemplates( 'wp_template_part' );
} );
test( 'Template can be opened in the site editor', async ( {
page,
editorUtils,
} ) => {
await page.goto( '/wp-admin/site-editor.php' );
await page.getByRole( 'button', { name: /Templates/i } ).click();
await page.getByRole( 'button', { name: /Checkout/i } ).click();
await editorUtils.enterEditMode();
await expect(
page
.frameLocator( 'iframe' )
.locator( 'button:has-text("Place order")' )
.first()
).toBeVisible();
} );
test( 'Template can be modified', async ( {
page,
admin,
editor,
editorUtils,
} ) => {
await admin.visitSiteEditor( {
postId: templatePath,
postType: templateType,
} );
await editorUtils.enterEditMode();
await editor.insertBlock( {
name: 'core/paragraph',
attributes: { content: 'Hello World' },
} );
await editor.saveSiteEditorEntities();
await page.goto( permalink, { waitUntil: 'networkidle' } );
await expect( page.getByText( 'Hello World' ).first() ).toBeVisible();
} );
} );

52
plugins/woocommerce-blocks/tests/e2e-pw/tests/templates/order-confirmation.block_theme.spec.ts Normal file
View File

@ -0,0 +1,52 @@
/**
* External dependencies
*/
import { test, expect } from '@woocommerce/e2e-playwright-utils';
const permalink = '/checkout/order-received';
const templatePath = 'woocommerce/woocommerce//order-confirmation';
const templateType = 'wp_template';
test.describe( 'Test the order confirmation template', async () => {
test( 'Template can be opened in the site editor', async ( {
page,
editorUtils,
} ) => {
await page.goto( '/wp-admin/site-editor.php' );
await page.getByRole( 'button', { name: /Templates/i } ).click();
await page
.getByRole( 'button', { name: /Order confirmation/i } )
.click();
await editorUtils.enterEditMode();
await expect(
page
.frameLocator( 'iframe' )
.locator(
'p:has-text("Thank you. Your order has been received.")'
)
.first()
).toBeVisible();
} );
test( 'Template can be modified', async ( {
page,
admin,
editor,
editorUtils,
} ) => {
await admin.visitSiteEditor( {
postId: templatePath,
postType: templateType,
} );
await editorUtils.enterEditMode();
await editor.insertBlock( {
name: 'core/paragraph',
attributes: { content: 'Hello World' },
} );
await editor.saveSiteEditorEntities();
await page.goto( permalink, { waitUntil: 'networkidle' } );
await expect( page.getByText( 'Hello World' ).first() ).toBeVisible();
} );
} );

11
plugins/woocommerce-blocks/tests/e2e-pw/utils/editor/EditorUtils.ts
View File

@ -4,9 +4,6 @@
import { Page } from '@playwright/test';
import { Editor } from '@wordpress/e2e-test-utils-playwright';
import { BlockRepresentation } from '@wordpress/e2e-test-utils-playwright/build-types/editor/insert-block';
/**
* Internal dependencies
*/
export class EditorUtils {
editor: Editor;
@ -66,4 +63,12 @@ export class EditorUtils {
.getBlockRootClientId( id );
}, clientId );
}
async enterEditMode() {
await this.editor.page.waitForSelector(
'.edit-site-visual-editor__editor-canvas[role="button"]',
{ timeout: 3000 }
);
await this.editor.canvas.click( 'body' );
}
}

9
plugins/woocommerce-blocks/tests/e2e-pw/utils/frontend/add-to-cart.ts Normal file
View File

@ -0,0 +1,9 @@
/**
* External dependencies
*/
import { Page } from '@playwright/test';
export const addToCart = async ( page: Page ) => {
await page.click( 'text=Add to cart' );
await page.waitForLoadState( 'networkidle' );
};

11
plugins/woocommerce-blocks/tests/e2e-pw/utils/frontend/go-to-shop.ts Normal file
View File

@ -0,0 +1,11 @@
/**
* External dependencies
*/
import { Page } from '@playwright/test';
// Navigate to the shop page.
export const goToShop = ( page: Page ) => {
page.goto( '/shop', {
waitUntil: 'networkidle',
} );
};

2
plugins/woocommerce-blocks/tests/e2e-pw/utils/frontend/index.ts
View File

@ -1 +1,3 @@
export * from './get-block-by-name';
export * from './go-to-shop';
export * from './add-to-cart';

5
plugins/woocommerce-blocks/tests/e2e-pw/utils/go-to-shop.ts
View File

@ -1,5 +0,0 @@
export const goToShop = () => {
page.goto( BASE_URL + '/shop', {
waitUntil: 'networkidle0',
} );
};