Fixed missing cart purge event trigger

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release Notes for Craft Commerce
 
+## Unreleased
+
+- Fixed a bug where the purge carts event wasn’t being triggered.
+- Added `craft\commerce\services\Carts::EVENT_BEFORE_PURGE_INACTIVE_CARTS`.
+
 ## 5.3.0 - 2025-01-30
 
 ### Store Management

src/events/CartPurgeEvent.php

@@ -12,10 +12,10 @@
 use craft\events\CancelableEvent;
 
 /**
- * Class CartEvent
+ * Class CartPurgeEvent
  *
  * @author Pixel & Tonic, Inc. <[email protected]>
- * @since 2.0
+ * @since 5.3
  */
 class CartPurgeEvent extends CancelableEvent
 {

src/services/Carts.php

@@ -38,6 +38,28 @@
  */
 class Carts extends Component
 {
+    /**
+     * @event CartPurgeEvent The event that is triggered before the carts are purged.
+     *
+     * This example modifies the query to only purge carts with a total price of 0.
+     * You can also set the `isValid` property to `false` to prevent the carts from being purged.
+     *
+     * ```php
+     * use craft\commerce\events\CartPurgeEvent;
+     * use craft\commerce\services\Carts;
+     * use yii\base\Event;
+     *
+     * Event::on(
+     *     Carts::class,
+     *     Carts::EVENT_BEFORE_PURGE_INACTIVE_CARTS,
+     *     function(CartPurgeEvent $event) {
+     *         $event->inactiveCartsQuery = $event->inactiveCartsQuery->andWhere(['totalPrice' => 0]);
+     *     }
+     * );
+     * ```
+     */
+    public const EVENT_BEFORE_PURGE_INACTIVE_CARTS = 'beforePurgeInactiveCarts';
+
     /**
      * @var array The configuration of the cart cookie.
      * @since 4.0.0
@@ -423,6 +445,10 @@ public function purgeIncompleteCarts(): int
             'inactiveCartsQuery' => $cartIdsQuery,
         ]);
 
+        if ($this->hasEventHandlers(self::EVENT_BEFORE_PURGE_INACTIVE_CARTS)) {
+            $this->trigger(self::EVENT_BEFORE_PURGE_INACTIVE_CARTS, $event);
+        }
+
         if (!$event->isValid) {
             return 0;
         }