FunnelKit Checkout - Order Summary, Mini Cart & Collapsible Order Summary Hooks

gistfile1.txt

# FunnelKit Checkout - Order Summary, Mini Cart & Collapsible Order Summary Hooks

This document contains all WordPress hooks (actions and filters) used in the Order Summary, Mini Cart, and Collapsible Order Summary components of the FunnelKit checkout.

---

## Table of Contents

1. [Order Summary Hooks](#order-summary-hooks)
2. [Mini Cart Hooks](#mini-cart-hooks)
3. [Collapsible Order Summary Hooks](#collapsible-order-summary-hooks)
4. [WooCommerce Standard Hooks Used](#woocommerce-standard-hooks-used)
5. [Common/Shared Hooks](#commonshared-hooks)

---

## Order Summary Hooks

### Actions

#### `wfacp_before_order_summary`
**Location:** `public/template-common/order-summary.php:37`
**Parameters:** `$field` (array), `$instance` (object)
**Description:** Fires before the order summary container is rendered.

#### `wfacp_after_order_summary`
**Location:** `public/template-common/order-summary.php:215`
**Parameters:** `$field` (array), `$instance` (object)
**Description:** Fires after the order summary container is rendered.

#### `wfacp_order_summary_before_shipping`
**Location:** `public/template-common/order-summary.php:166`
**Parameters:** None
**Description:** Fires before the shipping section in the order summary.

#### `wfacp_order_summary_after_shipping`
**Location:** `public/template-common/order-summary.php:181`
**Parameters:** None
**Description:** Fires after the shipping section in the order summary.

#### `wfacp_display_order_summary_undo_message`
**Location:** `includes/class-wfacp-template.php:1921`
**Parameters:** `$field` (array)
**Description:** Fires to display undo message when an item is removed from order summary (AJAX context).

#### `wfacp_woocommerce_cart_item_subtotal_except_subscription_placeholder`
**Location:** `public/template-common/order-summary.php:127`
**Parameters:** `$_product` (object), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Fires when displaying cart item subtotal placeholder for non-subscription products (when filter returns false).

### Filters

#### `wfacp_before_order_summary_html`
**Location:** `public/template-common/order-summary.php:20`
**Parameters:** `$field` (array)
**Description:** Filters the order summary field configuration before rendering.

#### `wfacp_cart_show_product_thumbnail`
**Location:** `public/template-common/order-summary.php:15, 48, 78`
**Parameters:** None (returns boolean)
**Description:** Controls whether to show product thumbnails in the order summary.

#### `wfacp_order_summary_cols_span`
**Location:** `public/template-common/order-summary.php:17`
**Parameters:** `$colspan_attr` (string)
**Description:** Filters the column span attribute for order summary table.

#### `wfacp_order_summary_column_item_heading`
**Location:** `public/template-common/order-summary.php:59`
**Parameters:** `$heading` (string) - Default: "Product"
**Description:** Filters the "Product" column heading in order summary.

#### `wfacp_order_summary_column_total_heading`
**Location:** `public/template-common/order-summary.php:62`
**Parameters:** `$heading` (string) - Default: "Total"
**Description:** Filters the "Total" column heading in order summary.

#### `wfacp_cart_image`
**Location:** `public/template-common/order-summary.php:81`
**Parameters:** `$thumbnail` (string), `$_product` (object)
**Description:** Filters the product thumbnail image HTML in order summary.

#### `wfacp_allow_woocommerce_after_cart_item_name_order_summary`
**Location:** `public/template-common/order-summary.php:101`
**Parameters:** `$allow` (boolean), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Controls whether to fire `woocommerce_after_cart_item_name` hook in order summary.

#### `wfacp_woocommerce_cart_item_subtotal_except_subscription`
**Location:** `public/template-common/order-summary.php:124`
**Parameters:** `$allow` (boolean), `$_product` (object), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Controls whether to display cart item subtotal for non-subscription products.

#### `wfacp_order_pay_summary_heading`
**Location:** `includes/class-wfacp-template.php:2608`
**Parameters:** `$heading` (string) - Default: "Review Order Summary"
**Description:** Filters the heading text for order pay summary page.

---

## Mini Cart Hooks

### Actions

#### `wfacp_mini_cart_top`
**Location:** `public/global/mini-cart/mini-cart.php:29`
**Parameters:** None
**Description:** Fires at the top of the mini cart container, before the heading.

#### `wfacp_mini_cart_bottom`
**Location:** `public/global/mini-cart/mini-cart.php:48`
**Parameters:** None
**Description:** Fires at the bottom of the mini cart container, after all content.

#### `wfacp_below_mini_cart_item`
**Location:** `public/global/mini-cart/mini-cart.php:39`
**Parameters:** `$instance` (object)
**Description:** Fires after mini cart items are displayed, before coupon section.

#### `wfacp_below_mini_cart_coupon`
**Location:** `public/global/mini-cart/mini-cart.php:43`
**Parameters:** `$instance` (object)
**Description:** Fires after mini cart coupon section, before review totals.

#### `wfacp_before_mini_cart_html`
**Location:** `public/global/mini-cart/mini-cart-items.php:34`
**Parameters:** None
**Description:** Fires before mini cart items HTML is rendered.

#### `wfacp_after_mini_cart_html`
**Location:** `public/global/mini-cart/mini-cart-items.php:36`
**Parameters:** None
**Description:** Fires after mini cart items HTML is rendered.

#### `wfacp_mini_cart_before_product_title`
**Location:** `public/global/mini-cart/mini-cart-items.php:115`
**Parameters:** `$_product` (object)
**Description:** Fires before the product title in mini cart items.

#### `wfacp_mini_cart_after_product_title`
**Location:** `public/global/mini-cart/mini-cart-items.php:195`
**Parameters:** `$_product` (object)
**Description:** Fires after the product title in mini cart items.

#### `wfacp_mini_cart_before_order_total`
**Location:** `public/global/mini-cart/mini-cart-review-totals.php:33`
**Parameters:** `$this` (object), `$args` (array)
**Description:** Fires before the order total section in mini cart review totals.

#### `wfacp_mini_cart_after_order_total`
**Location:** `public/global/mini-cart/mini-cart-review-totals.php:110`
**Parameters:** `$this` (object), `$args` (array)
**Description:** Fires after the order total section in mini cart review totals.

#### `wfacp_mini_cart_before_shipping`
**Location:** `public/global/mini-cart/mini-cart-review-totals.php:61`
**Parameters:** None
**Description:** Fires before the shipping section in mini cart review totals.

#### `wfacp_mini_cart_after_shipping`
**Location:** `public/global/mini-cart/mini-cart-review-totals.php:65`
**Parameters:** None
**Description:** Fires after the shipping section in mini cart review totals.

#### `wfacp_mini_cart_woocommerce_review_order_before_order_total`
**Location:** `public/global/mini-cart/mini-cart-review-totals.php:89`
**Parameters:** None
**Description:** Fires before order total in mini cart (before WooCommerce hook).

#### `wfacp_mini_cart_woocommerce_review_order_after_order_total`
**Location:** `public/global/mini-cart/mini-cart-review-totals.php:104`
**Parameters:** None
**Description:** Fires after order total in mini cart (after WooCommerce hook).

#### `wfacp_display_mini_cart_undo_message`
**Location:** `includes/class-wfacp-template.php:1914`
**Parameters:** None
**Description:** Fires to display undo message when an item is removed from mini cart (AJAX context).

#### `wfacp_disable_mini_cart_placeholder`
**Location:** `public/global/mini-cart/mini-cart.php:12`
**Parameters:** None
**Description:** Fires when mini cart is disabled (when `wfacp_disable_mini_cart` filter returns true).

#### `wfacp_display_quantity_increment_placeholder`
**Location:** `public/global/mini-cart/mini-cart-items.php:185`
**Parameters:** `$display` (boolean), `$cart_item` (array), `$item_quantity` (int), `$aero_item_key` (string), `$cart_item_key` (string)
**Description:** Fires when quantity increment is disabled (when `wfacp_display_quantity_increment` filter returns false).

#### `wfacp_mini_cart_widgets_elementor_editor`
**Location:** `builder/elementor/widgets/class-elementor-summary.php:400`
**Parameters:** `$this` (object)
**Description:** Fires in Elementor editor for mini cart widget customization.

### Filters

#### `wfacp_disable_mini_cart`
**Location:** `public/global/mini-cart/mini-cart.php:11`
**Parameters:** `$disable` (boolean), `$instance` (object), `$widget_id` (string)
**Description:** Controls whether to disable the mini cart display.

#### `wfacp_mini_cart_enable_delete_item`
**Location:** `public/global/mini-cart/mini-cart-items.php:51`
**Parameters:** `$enable_delete_item` (boolean), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Controls whether to enable delete item functionality for a specific cart item.

#### `wfacp_enable_delete_item`
**Location:** `public/global/mini-cart/mini-cart-items.php:78`
**Parameters:** `$enable_delete_item` (boolean), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Controls whether to enable delete item functionality (alternative filter).

#### `wfacp_allow_woocommerce_after_cart_item_name_mini_cart_widget`
**Location:** `public/global/mini-cart/mini-cart-items.php:135`
**Parameters:** `$allow` (boolean), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Controls whether to fire `woocommerce_after_cart_item_name` hook in mini cart.

#### `wfacp_display_quantity_increment`
**Location:** `public/global/mini-cart/mini-cart-items.php:162`
**Parameters:** `$display` (boolean), `$cart_item` (array), `$item_quantity` (int), `$aero_item_key` (string), `$cart_item_key` (string)
**Description:** Controls whether to display quantity increment/decrement controls in mini cart.

#### `wfacp_cart_item_min_max_quantity`
**Location:** `public/global/mini-cart/mini-cart-items.php:164`
**Parameters:** `$minMax` (array), `$cart_item` (array), `$aero_item_key` (string), `$cart_item_key` (string)
**Description:** Filters the minimum, maximum, and step values for quantity input in mini cart.

#### `wfacp_item_quantity`
**Location:** `public/global/mini-cart/mini-cart-items.php:169`
**Parameters:** `$item_quantity` (int), `$cart_item` (array)
**Description:** Filters the item quantity value before displaying in mini cart.

#### `wfacp_subscription_string`
**Location:** `public/global/mini-cart/mini-cart-items.php:151`
**Parameters:** `$subscription_product_string` (string), `$_product` (object), `$product_data` (array), `$cart_item_key` (string)
**Description:** Filters the subscription product string displayed in mini cart.

#### `wfacp_subscription_price_display`
**Location:** `public/global/mini-cart/mini-cart-items.php:209`
**Parameters:** `$price_show` (string), `$_product` (object), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Filters the subscription price display in mini cart.

#### `wfacp_mini_cart_enable_strike_through_price`
**Location:** `public/global/mini-cart/mini-cart-items.php:218`
**Parameters:** `$enable` (boolean)
**Description:** Controls whether to enable strike-through price display in mini cart.

#### `wfacp_show_subscription_string_old_version`
**Location:** `public/global/mini-cart/mini-cart-items.php:28`
**Parameters:** `$show` (boolean)
**Description:** Controls whether to show subscription string in old version format.

#### `wfacp_disable_subscriptions_sidebar_summary`
**Location:** `public/global/mini-cart/mini-cart-review-totals.php:98`
**Parameters:** `$disable` (boolean)
**Description:** Controls whether to disable WooCommerce Subscriptions sidebar summary in mini cart.

#### `wfacp_order_shipping_colspan`
**Location:** `public/global/mini-cart/mini-cart-review-totals.php:32`
**Parameters:** `$colspan` (int|string)
**Description:** Filters the column span for shipping row in mini cart review totals.

---

## Collapsible Order Summary Hooks

### Actions

#### `wfacp_before_sidebar_content`
**Location:** `public/template-common/template-parts/mobile-collapsible-mini-cart.php:95`
**Parameters:** None
**Description:** Fires before the collapsible sidebar content is rendered.

### Filters

#### `wfacp_collapsible_order_summary_cart_price`
**Location:** `public/template-common/template-parts/mobile-collapsible-mini-cart.php:15`
**Parameters:** `$price` (string)
**Description:** Filters the cart total price displayed in the collapsible order summary header.

#### `wfacp_collapsible_order_summary_dropdown_icon`
**Location:** `public/template-common/template-parts/mobile-collapsible-mini-cart.php:84`
**Parameters:** `$icon` (string)
**Description:** Filters the dropdown icon URL for collapsible order summary.

#### `wfacp_collapsible_optional_field_label`
**Location:** `includes/class-wfacp-template.php:3124`
**Parameters:** `$label` (string), `$field_key` (string), `$field` (array)
**Description:** Filters the label text for collapsible optional fields.

---

## WooCommerce Standard Hooks Used

These are standard WooCommerce hooks that are also used in the order summary, mini cart, and collapsible order summary components.

### Actions

#### `woocommerce_review_order_before_cart_contents`
**Location:** `public/template-common/order-summary.php:67`, `public/global/mini-cart/mini-cart-items.php:35, 42`
**Parameters:** None
**Description:** Fires before cart contents are displayed in review order.

#### `woocommerce_review_order_after_cart_contents`
**Location:** `public/template-common/order-summary.php:140`, `public/global/mini-cart/mini-cart-items.php:233`
**Parameters:** `$total_col` (int) - Total number of columns (in order summary)
**Description:** Fires after cart contents are displayed in review order.

#### `woocommerce_review_order_before_shipping`
**Location:** `public/template-common/order-summary.php:171`, `public/template-common/order-total.php:74`
**Parameters:** None
**Description:** Fires before shipping section in review order.

#### `woocommerce_review_order_after_shipping`
**Location:** `public/template-common/order-summary.php:178`, `public/template-common/order-total.php:80`
**Parameters:** None
**Description:** Fires after shipping section in review order.

#### `woocommerce_review_order_before_order_total`
**Location:** `public/template-common/order-summary.php:203`, `public/global/mini-cart/mini-cart-review-totals.php:90`
**Parameters:** None
**Description:** Fires before order total in review order.

#### `woocommerce_review_order_after_order_total`
**Location:** `public/template-common/order-summary.php:209`, `public/global/mini-cart/mini-cart-review-totals.php:103`
**Parameters:** None
**Description:** Fires after order total in review order.

#### `woocommerce_after_cart_item_name`
**Location:** `public/template-common/order-summary.php:105`, `public/global/mini-cart/mini-cart-items.php:139`
**Parameters:** `$cart_item` (array), `$cart_item_key` (string)
**Description:** Fires after cart item name is displayed (only if filter allows it).

#### `woocommerce_order_item_meta_end`
**Location:** `public/template-common/order-pay-summary.php:99`
**Parameters:** `$cart_item_key` (string), `$cart_item` (object), `$order` (object), `$plain_text` (boolean)
**Description:** Fires after order item meta is displayed (order pay page).

### Filters

#### `woocommerce_cart_item_product`
**Location:** `public/template-common/order-summary.php:69`, `public/global/mini-cart/mini-cart-items.php:50`
**Parameters:** `$_product` (object), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Filters the product object for a cart item.

#### `woocommerce_checkout_cart_item_visible`
**Location:** `public/template-common/order-summary.php:70`, `public/global/mini-cart/mini-cart-items.php:53`
**Parameters:** `$visible` (boolean), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Controls whether a cart item is visible in checkout.

#### `woocommerce_cart_item_class`
**Location:** `public/template-common/order-summary.php:72`, `public/global/mini-cart/mini-cart-items.php:85`
**Parameters:** `$class` (string), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Filters the CSS class for a cart item row.

#### `woocommerce_cart_item_name`
**Location:** `public/template-common/order-summary.php:96`, `public/global/mini-cart/mini-cart-items.php:131`
**Parameters:** `$name` (string), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Filters the cart item product name.

#### `woocommerce_checkout_cart_item_quantity`
**Location:** `public/template-common/order-summary.php:99`, `public/global/mini-cart/mini-cart-items.php:133`
**Parameters:** `$quantity_html` (string), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Filters the cart item quantity HTML.

#### `woocommerce_cart_item_subtotal`
**Location:** `public/template-common/order-summary.php:125`, `public/global/mini-cart/mini-cart-items.php:218`
**Parameters:** `$subtotal` (string), `$cart_item` (array), `$cart_item_key` (string)
**Description:** Filters the cart item subtotal HTML.

#### `woocommerce_cart_totals_coupon_label`
**Location:** `public/template-common/order-summary.php:152`, `public/global/mini-cart/mini-cart-review-totals.php:47`, `includes/class-wfacp-template.php:2075`
**Parameters:** `$label` (string), `$coupon` (object)
**Description:** Filters the coupon label HTML in cart totals.

#### `woocommerce_order_item_visible`
**Location:** `public/template-common/order-pay-summary.php:63`
**Parameters:** `$visible` (boolean), `$cart_item` (object)
**Description:** Controls whether an order item is visible (order pay page).

#### `woocommerce_order_item_class`
**Location:** `public/template-common/order-pay-summary.php:74`
**Parameters:** `$class` (string), `$cart_item` (object), `$cart_item_key` (string)
**Description:** Filters the CSS class for an order item row (order pay page).

#### `woocommerce_order_item_name`
**Location:** `public/template-common/order-pay-summary.php:95`
**Parameters:** `$name` (string), `$cart_item` (object), `$is_visible` (boolean)
**Description:** Filters the order item product name (order pay page).

#### `woocommerce_order_item_quantity_html`
**Location:** `public/template-common/order-pay-summary.php:97`
**Parameters:** `$quantity_html` (string), `$cart_item` (object), `$cart_item_key` (string)
**Description:** Filters the order item quantity HTML (order pay page).

---

## Common/Shared Hooks

### Actions

#### `wfacp_after_coupon_html`
**Location:** `public/template-common/order-summary.php:154`, `public/global/mini-cart/mini-cart-review-totals.php:49`
**Parameters:** `$coupon` (object)
**Description:** Fires after coupon HTML is displayed in order summary and mini cart.

#### `wfacp_before_order_total_field`
**Location:** `public/template-common/order-total.php:20`
**Parameters:** None
**Description:** Fires before the order total field is rendered.

#### `wfacp_after_order_total_field`
**Location:** `public/template-common/order-total.php:128`
**Parameters:** None
**Description:** Fires after the order total field is rendered.

### Filters

#### `wfacp_order_total_cols_span`
**Location:** `public/template-common/order-total.php:32`
**Parameters:** `$colspan` (string)
**Description:** Filters the column span attribute for order total table.

#### `wfacp_coupon_label_text`
**Location:** `includes/class-wfacp-template.php:2074`
**Parameters:** `$coupon_text` (string) - Default: "Coupon"
**Description:** Filters the coupon label text.

#### `wfacp_form_apply_coupon_button_text`
**Location:** `public/template-common/order-coupon.php:30`
**Parameters:** `$button_text` (string) - Default: "Apply"
**Description:** Filters the apply coupon button text.

#### `woocommerce_checkout_coupon_message`
**Location:** `public/template-common/order-coupon.php:40`
**Parameters:** `$message` (string)
**Description:** Filters the coupon message displayed when coupon field is collapsible.

---

## Notes

1. **Hook Priority:** Most hooks use the default priority of 10. You can adjust priority when adding your hooks if needed.

2. **AJAX Context:** Some hooks (like `wfacp_display_mini_cart_undo_message`) only fire during AJAX requests. Check `wp_doing_ajax()` if needed.

3. **Template Instance:** Many hooks receive the `$instance` parameter which is the `WFACP_Template` object. You can use this to access template methods and properties.

4. **Cart Item Keys:** Cart item keys are unique identifiers for items in the cart. They're used to identify specific items for operations like deletion or quantity updates.

5. **Compatibility:** These hooks are specific to FunnelKit Checkout. Standard WooCommerce hooks will also work but may behave differently in the FunnelKit context.

---

**Document Generated:** Based on FunnelKit Checkout plugin code analysis
**Last Updated:** 2024