利用可能なフィルター
このドキュメントでは、現在エクステンションで利用可能なフィルタの一覧と、それぞれのフィルタの使用法について説明します。フィルタの登録に関する情報は、チェックアウト – フィルタ登録 ページにあります。
カートラインアイテムフィルター
以下の Cart Line Items filters が利用可能です：
cartItemClasscartItemPriceitemNamesaleBadgePriceFormatshowRemoveItemLinksubtotalPriceFormat
以下のスクリーンショットは、個々のフィルターがどの部分に影響するかを示しています：
オーダー概要項目フィルター
以下のオーダーサマリーアイテムフィルターが利用可能です：
cartItemClasscartItemPriceitemNamesubtotalPriceFormat
以下のスクリーンショットは、個々のフィルターがどの部分に影響するかを示しています：
フッターアイテムフィルター
以下のTotals Footer Item filterが利用可能です：
totalLabeltotalValue。
チェックアウトと注文ボタンのフィルター
以下のレジ・注文ボタンフィルターが利用可能です：
proceedToCheckoutButtonLabelproceedToCheckoutButtonLinkplaceOrderButtonLabel
クーポンフィルター
以下のクーポンフィルターが利用可能です：
couponsshowApplyCouponNoticeshowRemoveCouponNotice
カートとチェックアウトの内部ブロックの追加タイプフィルター
以下の追加カート・チェックアウトインナーブロックタイプフィルターが利用可能です：
additionalCartCheckoutInnerBlockTypes。
複合フィルター
フィルターは組み合わせることもできる。次の例は、利用可能なフィルターのいくつかを組み合わせる方法を示しています。
const { registerCheckoutFilters } = window.wc.blocksCheckout;
const isOrderSummaryContext = ( args ) => args?.context === 'summary';
const modifyCartItemClass = ( defaultValue, extensions, args ) => {
if ( isOrderSummaryContext( args ) ) {
return 'my-custom-class';
}
return defaultValue;
};
const modifyCartItemPrice = ( defaultValue, extensions, args ) => {
if ( isOrderSummaryContext( args ) ) {
return '<price/> for all items';
}
return defaultValue;
};
const modifyItemName = ( defaultValue, extensions, args ) => {
if ( isOrderSummaryContext( args ) ) {
return `${ defaultValue }`;
}
return defaultValue;
};
const modifySubtotalPriceFormat = ( defaultValue, extensions, args ) => {
if ( isOrderSummaryContext( args ) ) {
return '<price/> per item';
}
return defaultValue;
};
registerCheckoutFilters( 'example-extension', {
cartItemClass: modifyCartItemClass,
cartItemPrice: modifyCartItemPrice,
itemName: modifyItemName,
subtotalPriceFormat: modifySubtotalPriceFormat,
} );
トラブルシューティング
管理者としてストアにログインしている場合、フィルターが正しく動作していないと、このようなエラーが表示されます。
エラーが表示されます。このエラーはコンソールにも表示されます。
