Hooks Documentation

Overview

This document contains details of hooks available in the Live Carts for WooCommerce plugin.

Plugin Custom Hooks

1. Action Hooks

phplugins_live_carts_cart_loaded

• Parameters: $cart (WooCommerce cart object)
• Description: Fired when cart is loaded on the frontend
• Pro Usage: Recalculates cart totals when necessary

phplugins_live_carts_cart_created

• Parameters: $cartId (cart ID)
• Description: Fired when new cart is created

phplugins_live_carts_cart_seen

• Parameters: $cartId (cart ID)
• Description: Fired when a new or existing cart is marked as "seen" on the frontend

phplugins_live_carts_cart_contents_updated

• Parameters: $cartId (cart ID)
• Description: Fired when cart contents are updated

phplugins_live_carts_cart_converted

• Parameters: $cartId (cart ID)
• Description: Fired when cart conversion is detected

phplugins_live_carts_cart_abandoned

• Parameters: $cartId (cart ID)
• Description: Fired when cart is marked as abandoned

phplugins_live_carts_admin_cart_details

• Parameters: $cart_id (cart ID)
• Description: Fired below the cart contents table in the admin
• Pro Usage: Adds recovery URL and create order button

phplugins_live_carts_settings_general

• Description: Fired after rendering the General section in the settings UI

phplugins_live_carts_save_settings

• Description: Fired when saving plugin settings

phplugins_live_carts_list_after_view_links (Pro)

• Description: Fired after status filter links in cart list
• Pro Usage: Adds "Show Filters" button for advanced filtering

phplugins_live_carts_recovery_email_sent (Pro)

• Parameters: $cart_id (cart ID), $email_id (recovery email post ID), $coupon_code (generated coupon code or empty string)
• Description: Fired when a recovery email is successfully sent to a customer
• Usage: Track email sends, integrate with analytics, trigger webhooks

2. Filter Hooks

phplugins_live_carts_cart_insert

• Parameters: $insert (array with data to insert at index 0, and insertion formats at index 1, corresponding to the last 2 arguments of wpdb::insert()
• Returns: Modified data to insert, and formats
• Description: Allows modifying data before inserting cart to database
• Pro Usage: Adds session_key to cart data

phplugins_live_carts_cart_ip_address

• Parameters: $ip_address (IP address)
• Returns: Modified IP address
• Description: Allows modifying IP address before saving

phplugins_live_carts_frontend_cart_id_html

• Parameters: $html (HTML to display), $cartId (cart ID)
• Returns: Modified HTML
• Description: Allows modifying HTML that displays cart ID on frontend

phplugins_live_carts_track_revisions

• Returns: true/false
• Description: Controls whether to track cart content revisions
• Pro Usage: Temporarily disables tracking during recalculation

phplugins_live_carts_abandon_time

• Returns: Time in seconds
• Default: 7200 (2 hours)
• Description: Defines how much time should elapse (at minimum) after a cart is last seen before it is marked as abandoned

phplugins_live_carts_archive_time

• Returns: Time in seconds
• Default: 2592000 (30 days)
• Description: Defines how much time should elapse (at minimum) after a cart is last seen before it is archived

phplugins_live_carts_admin_cart_contents

• Parameters: $contentsHtml (null - keep default), $cart_data (cart data), $contents (cart contents array)
• Returns: Rendered cart contents HTML or null to not override the default HTML
• Description: Allows replacing cart contents HTML in admin panel
• Pro Usage: Adds cart editor

phplugins_live_carts_list_filter_sql (Pro)

• Parameters: [$sql, $params] (SQL filter clause and prepared statement parameters)
• Returns: Modified [$sql, $params] array
• Description: Allows filtering cart list SQL query
• Pro Usage: Adds filtering by product, user, and cart value

live_carts_for_woocommerce_admin_page_class (Pro)

• Parameters: AdminPage::class (admin page class name)
• Returns: Modified class name
• Description: Allows replacing admin page class
• Pro Usage: Extends admin page with Pro features (cart editing, recovery URLs, etc.)

phplugins_live_carts_recovery_email_replacements (Pro)

• Parameters: $replacements (array of shortcode => value), $cart (cart object), $email_post (WP_Post object)
• Returns: Modified replacements array
• Description: Allows adding custom shortcodes for recovery emails
• Example: Add [cart_total], [store_name], custom fields

phplugins_live_carts_recovery_email_subject (Pro)

• Parameters: $subject (email subject after shortcode replacement), $cart (cart object), $email_post (WP_Post object)
• Returns: Modified subject
• Description: Allows modifying email subject before sending

phplugins_live_carts_recovery_email_body (Pro)

• Parameters: $body (email body after shortcode replacement), $cart (cart object), $email_post (WP_Post object)
• Returns: Modified body HTML
• Description: Allows modifying email body before sending

phplugins_live_carts_recovery_email_to (Pro)

• Parameters: $to (recipient email address), $cart (cart object), $email_post (WP_Post object)
• Returns: Modified recipient email
• Description: Allows changing email recipient

phplugins_live_carts_recovery_email_headers (Pro)

• Parameters: $headers (email headers array), $cart (cart object), $email_post (WP_Post object)
• Returns: Modified headers
• Description: Allows modifying email headers (From, Reply-To, etc.)

phplugins_live_carts_recovery_email_cart_contents_html (Pro)

• Parameters: $html (cart contents HTML), $cart_contents (cart contents array)
• Returns: Modified HTML
• Description: Allows customizing cart contents display in emails

Hook Availability

Hook Name	Free Version	Pro Version	Notes
Plugin Custom Hooks
phplugins_live_carts_cart_loaded	✅	✅	Cart loaded event
phplugins_live_carts_cart_created	✅	✅	Cart created event
phplugins_live_carts_cart_seen	✅	✅	Cart seen event
phplugins_live_carts_cart_contents_updated	✅	✅	Contents updated
phplugins_live_carts_cart_converted	✅	✅	Cart converted
phplugins_live_carts_cart_abandoned	✅	✅	Cart abandoned
phplugins_live_carts_cart_insert	✅	✅	Enhanced in Pro (session_key)
phplugins_live_carts_cart_ip_address	✅	✅	IP address handling
phplugins_live_carts_frontend_cart_id_html	✅	✅	Frontend cart ID
phplugins_live_carts_track_revisions	✅	✅	Revision tracking
phplugins_live_carts_abandon_time	✅	✅	Abandon time setting
phplugins_live_carts_archive_time	✅	✅	Archive time setting
phplugins_live_carts_admin_cart_contents	✅	✅	Enhanced in Pro (cart editor)
phplugins_live_carts_admin_cart_details	✅	✅	Enhanced in Pro (recovery URL, create order)
phplugins_live_carts_settings_general	✅	✅	General settings UI section
phplugins_live_carts_save_settings	✅	✅	Saving settings
phplugins_live_carts_list_after_view_links	❌	✅	Pro - Filter UI hook
phplugins_live_carts_list_filter_sql	❌	✅	Pro - SQL filtering
live_carts_for_woocommerce_admin_page_class	❌	✅	Pro - Admin page extension
phplugins_live_carts_recovery_email_sent	❌	✅	Pro - Email sent event
phplugins_live_carts_recovery_email_replacements	❌	✅	Pro - Custom shortcodes
phplugins_live_carts_recovery_email_subject	❌	✅	Pro - Email subject filter
phplugins_live_carts_recovery_email_body	❌	✅	Pro - Email body filter
phplugins_live_carts_recovery_email_to	❌	✅	Pro - Recipient filter
phplugins_live_carts_recovery_email_headers	❌	✅	Pro - Email headers filter
phplugins_live_carts_recovery_email_cart_contents_html	❌	✅	Pro - Cart contents in email