メインコンテンツへスキップ
WooCommerce 開発者向けドキュメント

WooCommerce の公式ドキュメントの日本語訳

英語版ドキュメント | サポート

< All Topics
Print

dom-events

DOM events

いくつかのブロックは、最新のデータを表示したり、特定の方法で動作するために、特定のイベントに反応する必要があります。例えば、カートの中身を更新するために'add to cart'イベントをリッスンする必要があるCartブロックや、商品がカートに追加されるたびに開かれるMini-Cartブロックがそうです。

WooCommerce コアイベント in WooCommerce ブロック

WooCommerce のコアは、商品がカートに追加された時やカートから削除された時など、特定のイベントをトリガーしたりリッスンするためにjQueryイベントを使用しています。WooCommerce Blocks では jQuery を使用しませんが、これらのイベントをリッスンする必要があります。これを実現するために、translatejQueryEventToNative()というユーティリティを用意し、jQueryイベントをリッスンし、イベントがトリガーされるたびに、関連する DOM ネイティブイベント(wc-blocks_ プレフィックス付き)をトリガーします。

WooCommerce ブロックイベント

wc-blocks_adding_to_cart

このイベントは WooCommerce コアでトリガーされる jQuery イベント adding_to_cart に相当します。これは商品をカートに追加するプロセスがサーバーに送信されたことを示しますが、商品が正常に追加されたかどうかはまだ表示されません。

WC ブロックでの使用例: Mini-Cart ブロックは、このイベントをリッスンして依存関係を追加します。

wc-blocks_added_to_cart

このイベントは WooCommerce コアでトリガーされる jQuery イベント added_to_cart に相当します。これは商品をカートに追加するプロセスが成功裏に終了したことを示します。

WC ブロックでの使用例: Cartブロックと Mini-Cart ブロック(useStoreCart() フック経由)は、コンテンツを更新する必要があるかどうかを知るために、このイベントをリッスンします。

detail パラメータ

パラメーター タイプ 初期値 説明
preserveCartData boolean false ストア内のカート・データを保存するかどうか。デフォルトでは false なので、 wc-blocks_added_to_cart イベントが発生するとカートデータは無効になり、このイベントをリッスンしているブロックはカートデータを再取得します。しかし、イベントをトリガーするコードがすでにストアを更新している場合(例えば、All Products ブロック)、preserveCartData: true を設定することで、他のブロックがデータを再取得するのを避けることができます。

wc-blocks_removed_from_cart

このイベントは WooCommerce コアでトリガーされる jQuery イベント removed_from_cart に相当します。カートから商品が削除されたことを示します。

WCブロックでの使用例: Cart ブロックと Mini-Cart ブロック(useStoreCart() フック経由)は、コンテンツを更新する必要があるかどうかを知るために、このイベントをリッスンします。

Table of Contents