{ "actions": [ { "name": "'cfw_order_bump_add_to_cart_product_type_' . $product_type", "file": "Model/Bumps/BumpAbstract.php", "type": "action", "doc": { "description": "Fires before order bump is added to the cart", "long_description": "", "tags": [ { "name": "since", "content": "9.0.0" }, { "name": "param", "content": "The product type", "types": [ "string" ], "variable": "$product_type" }, { "name": "param", "content": "The product ID", "types": [ "int" ], "variable": "$product_id" }, { "name": "param", "content": "The quantity", "types": [ "int" ], "variable": "$quantity" }, { "name": "param", "content": "The variation ID", "types": [ "int" ], "variable": "$variation_id" }, { "name": "param", "content": "The variation data", "types": [ "array" ], "variable": "$variation_data" }, { "name": "param", "content": "The metadata", "types": [ "array" ], "variable": "$metadata" }, { "name": "param", "content": "The product", "types": [ "\\WC_Product" ], "variable": "$offer_product" } ], "long_description_html": "" }, "args": 6 }, { "name": "'cfw_updated_setting_' . $setting", "file": "Managers/SettingsManagerAbstract.php", "type": "action_reference", "doc": { "description": "Fires when setting updates", "long_description": "", "tags": [ { "name": "since", "content": "10.1.7" }, { "name": "param", "content": "The new value.", "types": [ "mixed" ], "variable": "$value" }, { "name": "param", "content": "The old value.", "types": [ "mixed" ], "variable": "$old_value" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_acr_activate", "file": "DatabaseUpdatesManager.php", "type": "action", "doc": { "description": "Action: cfw_acr_activate", "long_description": "Fires when the plugin is activated.", "tags": [ { "name": "since", "content": "8.0.0" } ], "long_description_html": "

Fires when the plugin is activated.

" }, "args": 0 }, { "name": "cfw_after_admin_page_header", "file": "Admin/Pages/PageAbstract.php", "type": "action", "doc": { "description": "Fires after the admin page header.", "long_description": "", "tags": [ { "name": "param", "content": "The admin page.", "types": [ "\\PageAbstract" ], "variable": "$" }, { "name": "since", "content": "7.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_after_bump_display_price_calculation", "file": "Model/Bumps/BumpAbstract.php", "type": "action", "doc": { "description": "Action fired after calculating cart item display price for order bumps", "long_description": "This allows compatibility classes to re-enable price filters after display price calculations are complete.", "tags": [ { "name": "param", "content": "The bump object", "types": [ "\\BumpInterface" ], "variable": "$bump" }, { "name": "param", "content": "The cart item data", "types": [ "array" ], "variable": "$cart_item" }, { "name": "since", "content": "10.2.8" } ], "long_description_html": "

This allows compatibility classes to re-enable price filters after display price calculations are complete.

" }, "args": 2 }, { "name": "cfw_after_delivery_method", "file": "Features/LocalPickup.php", "type": "action", "doc": { "description": "Fires after the delivery method radio buttons are rendered.", "long_description": "", "tags": [ { "name": "since", "content": "7.3.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_header", "file": "Loaders/Redirect.php", "type": "action", "doc": { "description": "Fires after header is output", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_modal_variable_product_form", "file": "API/GetVariationFormAPI.php", "type": "action", "doc": { "description": "Action after modal order bump variable product form.", "long_description": "", "tags": [ { "name": "since", "content": "8.2.18" }, { "name": "param", "content": "", "types": [ "\\WC_Product" ], "variable": "$variable_product" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_after_plugin_data_upgrades", "file": "DatabaseUpdatesManager.php", "type": "action", "doc": { "description": "Fires after plugin data upgrades.", "long_description": "", "tags": [ { "name": "param", "content": "->db_version The current db version.", "types": [ "string" ], "variable": "$this" }, { "name": "since", "content": "5.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_after_update_checkout_calculated", "file": "Action/UpdateCheckoutAction.php", "type": "action", "doc": { "description": "Fires after shipping and totals calculated during update_checkout refresh", "long_description": "", "tags": [ { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_amazon_payment_gateway_found", "file": "Compatibility/Gateways/AmazonPayV1.php", "type": "action", "doc": { "description": "Fires after amazon gateway is found", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "The gateway", "types": [ "mixed" ], "variable": "$wc_gateway" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_angelleye_paypal_ec_is_express_checkout", "file": "Compatibility/Gateways/PayPalForWooCommerce.php", "type": "action", "doc": { "description": "Hook for when PayPal for WooCommerce is in express checkout mode", "long_description": "", "tags": [ { "name": "since", "content": "6.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_admin_page_header", "file": "Admin/Pages/PageAbstract.php", "type": "action", "doc": { "description": "Fires before the admin page header.", "long_description": "", "tags": [ { "name": "param", "content": "The admin page.", "types": [ "\\PageAbstract" ], "variable": "$" }, { "name": "since", "content": "7.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_before_bump_display_price_calculation", "file": "Model/Bumps/BumpAbstract.php", "type": "action", "doc": { "description": "Action fired before calculating cart item display price for order bumps", "long_description": "This allows compatibility classes to temporarily disable price filters to prevent double-discounting in display calculations.", "tags": [ { "name": "param", "content": "The bump object", "types": [ "\\BumpInterface" ], "variable": "$bump" }, { "name": "param", "content": "The cart item data", "types": [ "array" ], "variable": "$cart_item" }, { "name": "since", "content": "10.2.8" } ], "long_description_html": "

This allows compatibility classes to temporarily disable price filters to prevent double-discounting in display calculations.

" }, "args": 2 }, { "name": "cfw_before_get_data", "file": "Managers/AssetManager.php", "type": "action", "doc": { "description": "Fires before gathering data", "long_description": "", "tags": [ { "name": "since", "content": "9.0.38" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_header", "file": "Loaders/Redirect.php", "type": "action", "doc": { "description": "Fires before header is output", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_order_bump_add_to_cart", "file": "Model/Bumps/BumpAbstract.php", "type": "action", "doc": { "description": "Fires before order bump is added to the cart", "long_description": "", "tags": [ { "name": "since", "content": "9.0.0" }, { "name": "param", "content": "The order bump", "types": [ "\\BumpInterface" ], "variable": "$bump" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_before_plugin_data_upgrades", "file": "DatabaseUpdatesManager.php", "type": "action", "doc": { "description": "Fires before plugin data upgrades.", "long_description": "", "tags": [ { "name": "since", "content": "9.0.0" }, { "name": "param", "content": "The current database version.", "types": [ "int" ], "variable": "$db_version" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_before_process_checkout", "file": "Action/CompleteOrderAction.php", "type": "action", "doc": { "description": "Fires before checkout is processed in complete order action", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_update_side_cart_action", "file": "Action/UpdateSideCart.php", "type": "action", "doc": { "description": "Fires before updating the side cart.", "long_description": "", "tags": [ { "name": "param", "content": "The cart data.", "types": [ "array" ], "variable": "$cart_data" }, { "name": "since", "content": "6.0.6" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_checkout_loaded_pre_head", "file": "Loaders/LoaderAbstract.php", "type": "action", "doc": { "description": "Fires after the thank you page is initiated", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_order_review_tab", "file": "Features/OrderReviewStep.php", "type": "action", "doc": { "description": "Outputs order review step content", "long_description": "", "tags": [ { "name": "since", "content": "4.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_update_order_review", "file": "Action/UpdateCheckoutAction.php", "type": "action", "doc": { "description": "Fires when updating CheckoutWC order review", "long_description": "", "tags": [ { "name": "param", "content": "The POST data", "types": [ "string" ], "variable": "$post_data" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_custom_footer", "file": "Loaders/Redirect.php", "type": "action", "doc": { "description": "Fires when custom footer is hooked", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_custom_header", "file": "Loaders/Redirect.php", "type": "action", "doc": { "description": "Fires when custom header is hooked", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_delivery_method_changed", "file": "Features/LocalPickup.php", "type": "action", "doc": { "description": "Fires when delivery method changes", "long_description": "", "tags": [ { "name": "param", "content": "The current delivery method", "types": [ "string" ], "variable": "$delivery_method" }, { "name": "since", "content": "7.3.2" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_enqueue_scripts", "file": "Managers/AssetManager.php", "type": "action", "doc": { "description": "Fires after script setup", "long_description": "", "tags": [ { "name": "since", "content": "5.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_load_template_assets", "file": "Managers/AssetManager.php", "type": "action", "doc": { "description": "Fires to trigger Templates to load their assets", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_offer_accepted", "file": "Action/ProcessOfferPaymentAction.php", "type": "action", "doc": { "description": "Fires after successful offer acceptance", "long_description": "", "tags": [ { "name": "since", "content": "10.4.0" }, { "name": "param", "content": "Parent order.", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "Product data.", "types": [ "array" ], "variable": "$product_data" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_offer_added_to_order", "file": "Features/OneClick/OfferOrderManager.php", "type": "action", "doc": { "description": "Fires after offer added to existing order", "long_description": "", "tags": [ { "name": "since", "content": "10.4.0" }, { "name": "param", "content": "Parent order.", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "Product data.", "types": [ "array" ], "variable": "$product_data" }, { "name": "param", "content": "Order item ID.", "types": [ "int" ], "variable": "$item_id" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_offer_child_order_created", "file": "Features/OneClick/OfferOrderManager.php", "type": "action", "doc": { "description": "Fires after child order created", "long_description": "", "tags": [ { "name": "since", "content": "10.4.0" }, { "name": "param", "content": "Child order.", "types": [ "\\WC_Order" ], "variable": "$child_order" }, { "name": "param", "content": "Parent order.", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "Product data.", "types": [ "array" ], "variable": "$product_data" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_offer_payment_failed", "file": "Action/ProcessOfferPaymentAction.php", "type": "action", "doc": { "description": "Fires when offer payment failed", "long_description": "", "tags": [ { "name": "since", "content": "10.4.0" }, { "name": "param", "content": "Parent order.", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "Product data.", "types": [ "array" ], "variable": "$product_data" }, { "name": "param", "content": "Gateway instance.", "types": [ "\\GatewayInterface" ], "variable": "$gateway" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_offer_payment_succeeded_order_update_failed", "file": "Action/ProcessOfferPaymentAction.php", "type": "action", "doc": { "description": "Fires when offer payment succeeded but order update failed", "long_description": "", "tags": [ { "name": "since", "content": "10.4.0" }, { "name": "param", "content": "Parent order.", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "Product data.", "types": [ "array" ], "variable": "$product_data" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_offer_refunded", "file": "Features/OneClick/OfferRefundManager.php", "type": "action", "doc": { "description": "Fires after offer refunded successfully", "long_description": "", "tags": [ { "name": "since", "content": "10.4.0" }, { "name": "param", "content": "Order object.", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "Order item.", "types": [ "\\WC_Order_Item" ], "variable": "$item" }, { "name": "param", "content": "Bump ID.", "types": [ "int" ], "variable": "$bump_id" }, { "name": "param", "content": "Refund transaction ID.", "types": [ "string" ], "variable": "$refund_txn_id" } ], "long_description_html": "" }, "args": 4 }, { "name": "cfw_order_bump_added_to_cart", "file": "Features/OrderBumps.php", "type": "action", "doc": { "description": "Action hook to run after an order bump is added to the cart", "long_description": "", "tags": [ { "name": "param", "content": "The ID of the order bump", "types": [ "int" ], "variable": "$bump_id" }, { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_register_ab_test_types", "file": "Features/ABTesting/ABTestTypeRegistry.php", "type": "action", "doc": { "description": "Allow third parties to register additional test types", "long_description": "", "tags": [ { "name": "param", "content": "The registry instance", "types": [ "\\ABTestTypeRegistry" ], "variable": "$registry" }, { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_template_after_init_order_pay", "file": "Loaders/LoaderAbstract.php", "type": "action", "doc": { "description": "Fires when order pay page is initted", "long_description": "", "tags": [ { "name": "since", "content": "8.1.6" }, { "name": "param", "content": "The global template parameters", "types": [ "array" ], "variable": "$global_template_parameters" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_template_after_load", "file": "Loaders/LoaderAbstract.php", "type": "action", "doc": { "description": "Fires after template pieces are loaded", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The template file", "types": [ "string" ], "variable": "$template_file" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_template_before_load", "file": "Loaders/LoaderAbstract.php", "type": "action", "doc": { "description": "Fires before template pieces are loaded", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The template file", "types": [ "string" ], "variable": "$template_file" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_template_load_after_{$template_name}_{$template_piece_name}", "file": "Model/Template.php", "type": "action", "doc": { "description": "Fires after template has been echoed out", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_template_load_before_{$template_name}_{$template_piece_name}", "file": "Model/Template.php", "type": "action", "doc": { "description": "Fires before template is output", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_update_checkout_after_customer_save", "file": "Action/UpdateCheckoutAction.php", "type": "action", "doc": { "description": "Fires after customer address data has been updated. This is where we do cart updates", "long_description": "", "tags": [ { "name": "since", "content": "7.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_updated_setting", "file": "Managers/SettingsManagerAbstract.php", "type": "action_reference", "doc": { "description": "Fires when setting updates", "long_description": "", "tags": [ { "name": "since", "content": "10.1.7" }, { "name": "param", "content": "The setting key", "types": [ "string" ], "variable": "$setting" }, { "name": "param", "content": "The new value.", "types": [ "mixed" ], "variable": "$value" }, { "name": "param", "content": "The old value.", "types": [ "mixed" ], "variable": "$old_value" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_updated_to_1017", "file": "DatabaseUpdatesManager.php", "type": "action", "doc": { "description": "Action hook fired after the 10.1.7 database update routine runs.", "long_description": "Used to trigger actions like initial telemetry sync.", "tags": [ { "name": "since", "content": "10.1.7" } ], "long_description_html": "

Used to trigger actions like initial telemetry sync.

" }, "args": 0 }, { "name": "cfw_updated_to_1018", "file": "DatabaseUpdatesManager.php", "type": "action", "doc": { "description": "Action hook fired after the 10.1.8 database update routine runs.", "long_description": "Used to trigger actions like initial telemetry sync.", "tags": [ { "name": "since", "content": "10.1.8" } ], "long_description_html": "

Used to trigger actions like initial telemetry sync.

" }, "args": 0 }, { "name": "cfw_updated_to_1020", "file": "DatabaseUpdatesManager.php", "type": "action", "doc": { "description": "Action hook fired after the 10.2.0 database update routine runs.", "long_description": "Used to trigger actions when Turnstile feature is added.", "tags": [ { "name": "since", "content": "10.2.0" } ], "long_description_html": "

Used to trigger actions when Turnstile feature is added.

" }, "args": 0 }, { "name": "cfw_updated_to_1032", "file": "DatabaseUpdatesManager.php", "type": "action", "doc": { "description": "Action hook fired after the 10.3.2 database update routine runs.", "long_description": "", "tags": [ { "name": "since", "content": "10.3.2" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_updated_to_1036", "file": "DatabaseUpdatesManager.php", "type": "action", "doc": { "description": "Action hook fired after the 10.3.2 database update routine runs.", "long_description": "", "tags": [ { "name": "since", "content": "10.3.6" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_wp_footer", "file": "Loaders/Redirect.php", "type": "action", "doc": { "description": "Fires after wp_footer() is called", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_wp_head", "file": "Loaders/Redirect.php", "type": "action", "doc": { "description": "Fires after wp_head()", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "post_edd_sl_plugin_updater_setup", "file": "Managers/Helpers/EDD_SL_Plugin_Updater.php", "type": "action", "doc": { "description": "Fires after the $edd_plugin_data is setup.", "long_description": "", "tags": [ { "name": "param", "content": "Array of EDD SL plugin data.", "types": [ "array" ], "variable": "$edd_plugin_data" } ], "long_description_html": "" }, "args": 1 }, { "name": "$hook_name", "file": "hook-wrapper-functions.php", "type": "action", "doc": { "description": "Action hook", "long_description": "", "tags": [ { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_after_breadcrumb_navigation", "file": "functions.php", "type": "action", "doc": { "description": "Fires after breadcrumb navigation is output", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_cart_summary", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after cart summary before closing tag", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_cart_summary_totals", "file": "functions.php", "type": "action", "doc": { "description": "Fires at end of cart summary totals table before tag", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_coupon_module", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after coupon module", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_customer_info_account_details", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before account details on customer info tab", "long_description": "", "tags": [ { "name": "since", "content": "7.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_customer_info_address_heading", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after customer info address heading", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_customer_info_billing_address_heading", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after customer info address billing heading", "long_description": "", "tags": [ { "name": "since", "content": "4.0.4" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_customer_info_shipping_address_heading", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after customer info address shipping heading", "long_description": "", "tags": [ { "name": "since", "content": "4.0.4" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_enhanced_login_prompt", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after enhanced login prompt", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_modal_order_bump_regular_product_form", "file": "functions.php", "type": "action", "doc": { "description": "Action after modal order bump regular product form.", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "\\WC_Product" ], "variable": "$product" }, { "name": "param", "content": "", "types": [ "\\BumpInterface" ], "variable": "$bump" }, { "name": "since", "content": "8.2.18" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_after_modal_order_bump_variable_product_form", "file": "functions.php", "type": "action", "doc": { "description": "Action after modal order bump variable product form.", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "\\WC_Product" ], "variable": "$variable_product" }, { "name": "param", "content": "", "types": [ "\\BumpInterface" ], "variable": "$bump" }, { "name": "since", "content": "8.2.18" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_after_payment_information_address_heading", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after the billing address heading on the payment tab", "long_description": "", "tags": [ { "name": "since", "content": "5.3.2" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_payment_methods_block", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after the payment methods block", "long_description": "", "tags": [ { "name": "since", "content": "7.2.7" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_after_same_as_shipping_address_label", "file": "functions.php", "type": "action", "doc": { "description": "Fires after same as shipping address label", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_shipping_packages", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after shipping packages component", "long_description": "", "tags": [ { "name": "since", "content": "9.0.8" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_thank_you_order_updates_text", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after the order updates text is output", "long_description": "", "tags": [ { "name": "since", "content": "7.2.7" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_before_breadcrumb_navigation", "file": "functions.php", "type": "action", "doc": { "description": "Fires before breadcrumb navigation is output", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_cart_item_subtotal", "file": "functions.php", "type": "action", "doc": { "description": "This filter documented in elsewhere in this file", "long_description": "", "tags": [], "long_description_html": "" }, "args": 1 }, { "name": "cfw_before_cart_summary_totals", "file": "functions.php", "type": "action", "doc": { "description": "Fires at start of cart summary totals table", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_coupon_module", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before coupon module", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_before_customer_info_account_details", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before account details on customer info tab", "long_description": "", "tags": [ { "name": "since", "content": "7.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_enhanced_login_prompt", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before enhanced login prompt", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_order_pay_submit", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before order pay submit", "long_description": "", "tags": [ { "name": "since", "content": "10.2.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_payment_method_heading", "file": "functions.php", "type": "action", "doc": { "description": "Fires above the payment method heading", "long_description": "", "tags": [ { "name": "since", "content": "5.1.1" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_payment_methods_block", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before payment methods block", "long_description": "", "tags": [ { "name": "since", "content": "7.2.7" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_before_print_notices", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before printing notices", "long_description": "", "tags": [ { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_thank_you_customer_information", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before thank you customer information output (after Information heading)", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_cart_html_before_cart_container", "file": "template-functions.php", "type": "action", "doc": { "description": "Before cart html table output", "long_description": "", "tags": [ { "name": "since", "content": "9.0.39" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_cart_updated", "file": "functions.php", "type": "action", "doc": { "description": "Fires after the cart is updated", "long_description": "", "tags": [ { "name": "param", "content": "Whether the cart was updated", "types": [ "bool" ], "variable": "$cart_updated" }, { "name": "param", "content": "The context of the cart update", "types": [ "string" ], "variable": "$context" }, { "name": "since", "content": "6.1.7" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_checkout_after_billing_address", "file": "functions.php", "type": "action", "doc": { "description": "Fires after billing address", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_customer_info_address", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires at the bottom of customer info address module after closing ", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_customer_info_tab_nav", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after customer info tab navigation container", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_email", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after email field output", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_payment_method_tab_nav", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after payment method tab navigation container", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_payment_methods", "file": "functions.php", "type": "action", "doc": { "description": "Fires at end of payment methods container before tag", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_payment_tab_billing_address", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after payment method tab billing address", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_shipping_address", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after shipping address", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_shipping_method_tab_nav", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after shipping method tab navigation container", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_billing_address", "file": "functions.php", "type": "action", "doc": { "description": "Fires before billing address radio group is output", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_customer_info_address", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before customer info address module", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_customer_info_tab_nav", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before customer info tab navigation container", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_payment_method_tab_nav", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before payment method tab navigation container", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_payment_method_terms_checkbox", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before payment method terms and conditions output", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_payment_methods", "file": "functions.php", "type": "action", "doc": { "description": "Fires after payment methods heading and before transaction are encrypted statement", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_shipping_address", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before shipping address", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_shipping_method_tab_nav", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before shipping method tab navigation container", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_customer_info_tab", "file": "template-functions.php", "type": "action", "doc": { "description": "Outputs customer info tab content", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_payment_method_tab", "file": "template-functions.php", "type": "action", "doc": { "description": "Outputs customer info tab content", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_shipping_method_tab", "file": "template-functions.php", "type": "action", "doc": { "description": "Outputs customer info tab content", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_do_plugin_deactivation", "file": "init.php", "type": "action", "doc": { "description": "Fires after plugin deactivation.", "long_description": "", "tags": [ { "name": "since", "content": "1.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_end_billing_address_container", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before billing address inside billing address container", "long_description": "", "tags": [ { "name": "since", "content": "4.0.4" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_end_shipping_address_container", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires after shipping address inside shipping address container", "long_description": "", "tags": [ { "name": "since", "content": "4.0.4" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_get_payment_methods_html", "file": "functions.php", "type": "action", "doc": { "description": "Fires before payment methods html is fetched", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_init_ab_tests", "file": "premium-init.php", "type": "action", "doc": { "description": "Load AB tests here", "long_description": "", "tags": [ { "name": "since", "content": "8.2.8" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_order_item_after_data", "file": "functions.php", "type": "action", "doc": { "description": "Fires after cart item data output", "long_description": "", "tags": [ { "name": "param", "content": "->get_raw_item() Raw item data", "types": [ "array" ], "variable": "$item" }, { "name": "param", "content": "->get_item_key() Item key", "types": [ "string" ], "variable": "$item" }, { "name": "param", "content": "Order item object", "types": [ "\\OrderItem" ], "variable": "$item" }, { "name": "since", "content": "7.1.3" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_output_fieldset", "file": "functions.php", "type": "action", "doc": { "description": "Filter the account checkout fields.", "long_description": "", "tags": [ { "name": "since", "content": "7.2.1" }, { "name": "param", "content": "The checkout fieldset", "types": [ "array" ], "variable": "$field_set" }, { "name": "param", "content": "The fieldset type", "types": [ "string" ], "variable": "$type" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_payment_gateway_list_{$gateway->id}_alternate", "file": "functions.php", "type": "action_reference", "doc": { "description": "Fires after payment method LI to allow alternate / additional output", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_payment_methods_ul_end", "file": "functions.php", "type": "action", "doc": { "description": "Fires after bottom of payment methods UL", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_payment_methods_ul_start", "file": "functions.php", "type": "action", "doc": { "description": "Fires at start of payment methods UL", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_payment_nav_place_order_button", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires in the order review tab place order button container.", "long_description": "", "tags": [ { "name": "since", "content": "4.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_payment_request_buttons", "file": "template-functions.php", "type": "action", "doc": { "description": "Hook for adding payment request buttons", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_permissioned_init", "file": "init.php", "type": "action", "doc": { "description": "Permissioned Init", "long_description": "This hook runs on init if CheckoutWC is enabled and the license is valid or free, or the current user is an admin", "tags": [ { "name": "since", "content": "8.2.11" } ], "long_description_html": "

This hook runs on init if CheckoutWC is enabled and the license is valid or free, or the current user is an admin

" }, "args": 0 }, { "name": "cfw_start_billing_address_container", "file": "functions.php", "type": "action", "doc": { "description": "Fires before billing address inside billing address container", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_start_shipping_address_container", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before shipping address inside shipping address container", "long_description": "", "tags": [ { "name": "since", "content": "4.0.4" } ], "long_description_html": "" }, "args": 0 }, { "name": "woocommerce_review_order_before_submit", "file": "template-functions.php", "type": "action", "doc": { "description": "Fires before payment method tab navigation container", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_after_footer", "file": "futurist/footer.php", "type": "action", "doc": { "description": "Fires at the bottom of footer", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_before_footer", "file": "futurist/footer.php", "type": "action", "doc": { "description": "Fires at the top of footer", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_cart_summary_container", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires after inside the cart summary sidebar container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_main_container", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires after the
container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The checkout object", "types": [ "\\WC_Checkout" ], "variable": "$checkout" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_checkout_after_order_review", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires at the bottom of the #order_review container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_after_order_review_container", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires after the #order_review container inside the checkout form", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_main_container", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires before
container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The checkout object", "types": [ "\\WC_Checkout" ], "variable": "$checkout" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_checkout_before_order_review", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires at the top of the #order_review container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_before_order_review_container", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires before the #order_review container inside the checkout form", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_cart_summary", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires inside the cart summary sidebar container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_form", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires to allow standard CheckoutWC form to be replaced.", "long_description": "Only fires when cfw_replace_form is true", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "

Only fires when cfw_replace_form is true

" }, "args": 0 }, { "name": "cfw_checkout_main_container_end", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires at the bottom of
container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The checkout object", "types": [ "\\WC_Checkout" ], "variable": "$checkout" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_checkout_main_container_start", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires at the beginning of the
container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_checkout_tabs", "file": "futurist/content.php", "type": "action", "doc": { "description": "Fires in the #order_review container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_footer_content", "file": "futurist/footer.php", "type": "action", "doc": { "description": "Hook to output footer content", "long_description": "", "tags": [ { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_order_pay_after_main_container", "file": "futurist/order-pay.php", "type": "action", "doc": { "description": "Fires after
container on order pay page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_order_pay_after_order_review", "file": "futurist/order-pay.php", "type": "action", "doc": { "description": "Fires at bottom of #order_review on order pay page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_order_pay_before_main_container", "file": "futurist/order-pay.php", "type": "action", "doc": { "description": "Fires before
container on order pay page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_order_pay_before_order_review", "file": "futurist/order-pay.php", "type": "action", "doc": { "description": "Fires at top of #order_review on order pay page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_order_pay_cart_summary", "file": "futurist/order-pay.php", "type": "action", "doc": { "description": "Fires in cart summary sidebar container", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_order_pay_content", "file": "futurist/order-pay.php", "type": "action", "doc": { "description": "Fires in #order_review container on order pay page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "Whether to call receipt hook", "types": [ "bool" ], "variable": "$call_receipt_hook" }, { "name": "param", "content": "The available gateways", "types": [ "array" ], "variable": "$available_gateways" }, { "name": "param", "content": "The text to use for the place order button", "types": [ "string" ], "variable": "$order_button_text" } ], "long_description_html": "" }, "args": 4 }, { "name": "cfw_order_pay_main_container_end", "file": "futurist/order-pay.php", "type": "action", "doc": { "description": "Fires at bottom of
container on order pay page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_order_pay_main_container_start", "file": "futurist/order-pay.php", "type": "action", "doc": { "description": "Fires at top of
container on order pay page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_after_main_container", "file": "futurist/thank-you.php", "type": "action", "doc": { "description": "Fires after
container on thank you page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_after_order_review", "file": "futurist/thank-you.php", "type": "action", "doc": { "description": "Fires at the end of
container on thank you page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_thank_you_before_main_container", "file": "futurist/thank-you.php", "type": "action", "doc": { "description": "Fires before
container on thank you page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_before_order_review", "file": "futurist/thank-you.php", "type": "action", "doc": { "description": "Fires at top of #order_review on thank you page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 0 }, { "name": "cfw_thank_you_cart_summary", "file": "futurist/thank-you.php", "type": "action", "doc": { "description": "Fires in cart summary sidebar container on thank you page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_content", "file": "futurist/thank-you.php", "type": "action", "doc": { "description": "Fires before
container on thank you page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "The order statuses we are progressing through", "types": [ "array" ], "variable": "$order_statuses" }, { "name": "param", "content": "Whether to show downloads section", "types": [ "bool" ], "variable": "$show_downloads" }, { "name": "param", "content": "The downloads", "types": [ "array" ], "variable": "$downloads" } ], "long_description_html": "" }, "args": 4 }, { "name": "cfw_thank_you_main_container_end", "file": "futurist/thank-you.php", "type": "action", "doc": { "description": "Fires at the bottom of
container on thank you page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_main_container_start", "file": "futurist/thank-you.php", "type": "action", "doc": { "description": "Fires at top of
container on thank you page", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 1 } ], "filters": [ { "name": "cfw_acr_cart_meta", "file": "Features/AbandonedCartRecovery.php", "type": "filter", "doc": { "description": "Filter the meta fields to be tracked for abandoned carts.", "long_description": "", "tags": [ { "name": "since", "content": "8.2.7" }, { "name": "param", "content": "", "types": [ "array" ], "variable": "$meta_fields" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_acr_carts", "file": "API/AbandonedCartRecoveryReportAPI.php", "type": "filter", "doc": { "description": "Filter the carts for the abandoned cart recovery report stats dashboard.", "long_description": "", "tags": [ { "name": "param", "content": "The carts.", "types": [ "array" ], "variable": "$carts" }, { "name": "param", "content": "The calling context", "types": [ "string" ], "variable": "$context" }, { "name": "since", "content": "8.2.28" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_acr_email_headers", "file": "Features/AbandonedCartRecovery.php", "type": "filter", "doc": { "description": "Filter the email headers", "long_description": "", "tags": [ { "name": "since", "content": "9.0.9" }, { "name": "param", "content": "", "types": [ "array" ], "variable": "$headers" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_acr_exclude_cart", "file": "Features/AbandonedCartRecovery.php", "type": "filter", "doc": { "description": "Filter whether to exclude tracking the cart", "long_description": "", "tags": [ { "name": "since", "content": "9.0.37" }, { "name": "param", "content": "", "types": [ "bool" ], "variable": "$exclude_cart" }, { "name": "param", "content": "", "types": [ "string" ], "variable": "$email" }, { "name": "param", "content": "", "types": [ "array" ], "variable": "$cart_contents" }, { "name": "param", "content": "", "types": [ "float" ], "variable": "$subtotal" }, { "name": "param", "content": "", "types": [ "string" ], "variable": "$first_name" }, { "name": "param", "content": "", "types": [ "string" ], "variable": "$last_name" }, { "name": "param", "content": "", "types": [ "array" ], "variable": "$fields" }, { "name": "param", "content": "", "types": [ "array" ], "variable": "$meta" } ], "long_description_html": "" }, "args": 8 }, { "name": "cfw_acr_send_to_email", "file": "Features/AbandonedCartRecovery.php", "type": "filter", "doc": { "description": "Filter the email send to address", "long_description": "", "tags": [ { "name": "since", "content": "9.0.37" }, { "name": "param", "content": "The email address to send the email to", "types": [ "string" ], "variable": "$send_to_email" }, { "name": "param", "content": "The tracked cart object", "types": [ "\\stdClass" ], "variable": "$cart" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_acr_track_cart_without_emails", "file": "Features/AbandonedCartRecovery.php", "type": "filter", "doc": { "description": "Filter whether to track carts without emails setup", "long_description": "", "tags": [ { "name": "since", "content": "8.2.18" }, { "name": "param", "content": "", "types": [ "bool" ], "variable": "$track_cart_without_emails" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_active_campaign_checkbox_hook", "file": "Compatibility/Plugins/ActiveCampaign.php", "type": "filter", "doc": { "description": "Filters hook to render Active Campaign checkbox output", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "The action hook to render on", "types": [ "string" ], "variable": "$render_on" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_active_theme_color_settings", "file": "Admin/Pages/Appearance.php", "type": "filter", "doc": { "description": "Filters the active theme colors settings.", "long_description": "", "tags": [ { "name": "param", "content": "The active theme colors settings.", "types": [ "array" ], "variable": "$color_settings" }, { "name": "since", "content": "5.1.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_add_to_cart_redirect", "file": "Action/AddToCartAction.php", "type": "filter", "doc": { "description": "Filter the add to cart redirect URL.", "long_description": "", "tags": [ { "name": "since", "content": "7.3.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_additional_side_cart_trigger_selectors", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to automatically generate password for new accounts", "long_description": "", "tags": [ { "name": "param", "content": "CSS selector for additional side cart open buttons / links", "types": [ "string" ], "variable": "$additional_side_cart_trigger_selectors" }, { "name": "since", "content": "5.4.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_address_autocomplete_billing_countries", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter list of billing country restrictions for Google Maps address autocomplete", "long_description": "", "tags": [ { "name": "param", "content": "List of country restrictions for Google Maps address autocomplete", "types": [ "array" ], "variable": "$address_autocomplete_billing_countries" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_address_autocomplete_shipping_countries", "file": "Features/GoogleAddressAutocomplete.php", "type": "filter", "doc": { "description": "Filter list of shipping country restrictions for Google Maps address autocomplete", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "List of country restrictions for Google Maps address autocomplete", "types": [ "array" ], "variable": "$address_autocomplete_shipping_countries" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_address_field_priorities", "file": "AddressFieldsAugmenter.php", "type": "filter", "doc": { "description": "Filter address field priorities", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "The address field priorities keyed by field key", "types": [ "array" ], "variable": "$priorities" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_admin_integrations_checkbox_fields", "file": "Admin/Pages/Integrations.php", "type": "filter", "doc": { "description": "Filters third party checkboxes here: WP Admin > CheckoutWC > Advanced > Integrations", "long_description": "Use to add additional integration settings", "tags": [ { "name": "param", "content": "The integrations admin page class", "types": [ "array" ], "variable": "$integrations" }, { "name": "since", "content": "9.0.0" } ], "long_description_html": "

Use to add additional integration settings

" }, "args": 1 }, { "name": "cfw_admin_page_data", "file": "Admin/Pages/PageAbstract.php", "type": "filter", "doc": { "description": "Filter the admin page data", "long_description": "", "tags": [ { "name": "since", "content": "9.0.0" }, { "name": "param", "content": "", "types": [ "array" ], "variable": "$data" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_allow_html_in_formatted_item_data_value", "file": "Model/CartItem.php", "type": "filter", "doc": { "description": "Filter whether to allow HTML in formatted item data value.", "long_description": "", "tags": [ { "name": "since", "content": "9.0.33" }, { "name": "param", "content": "Whether to allow HTML in formatted item data value.", "types": [ "bool" ], "variable": "$allow_html_in_formatted_item_data_value" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_allow_international_phone_field_country_dropdown", "file": "Features/InternationalPhoneField.php", "type": "filter", "doc": { "description": "Filter to allow the country dropdown to be disabled", "long_description": "", "tags": [ { "name": "since", "content": "5.3.5" }, { "name": "param", "content": "", "types": [ "bool" ], "variable": "$allow" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_allow_order_bump_coupons", "file": "Features/OrderBumps.php", "type": "filter", "doc": { "description": "Filter whether to allow order bump coupons", "long_description": "", "tags": [ { "name": "param", "content": "Whether to allow order bump coupons", "types": [ "bool" ], "variable": "$allow" }, { "name": "param", "content": "The ID of the order bump", "types": [ "int" ], "variable": "$bump_id" }, { "name": "since", "content": "8.2.14" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_amazon_suppress_shipping_field_validation", "file": "Compatibility/Gateways/AmazonPayLegacy.php", "type": "filter", "doc": { "description": "Filters whether to suppress shipping field validation when logged into Amazon Pay", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "True suppress validation (Default), false validate", "types": [ "bool" ], "variable": "$suppress_validation" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_billing_address_heading", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters billing address heading on payment method tab", "long_description": "", "tags": [ { "name": "param", "content": "Billing address heading on payment method tab", "types": [ "string" ], "variable": "$billing_address_heading" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_blocked_script_handles", "file": "Loaders/Redirect.php", "type": "filter", "doc": { "description": "Filters blocked script handles", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The blocked script handles", "types": [ "array" ], "variable": "$blocked_script_handles" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_blocked_style_handles", "file": "Loaders/Redirect.php", "type": "filter", "doc": { "description": "Filters blocked stylesheet handles", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The blocked stylesheet handles", "types": [ "array" ], "variable": "$blocked_style_handles" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_body_classes", "file": "Loaders/Redirect.php", "type": "filter", "doc": { "description": "Filter CheckoutWC specific body classes", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The body css classes", "types": [ "array" ], "variable": "$css_classes" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_breadcrumb_review_step_label", "file": "Features/OrderReviewStep.php", "type": "filter", "doc": { "description": "Filter review step breadcrumb label", "long_description": "", "tags": [ { "name": "since", "content": "7.5.0" }, { "name": "param", "content": "The review step breadcrumb label", "types": [ "string" ], "variable": "$label" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_bypass_login_modal_shown_cookie", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Bypass cookie for automatically showing login modal", "long_description": "", "tags": [ { "name": "param", "content": "Bypass cookie for automatically showing login modal (default: false, do not bypass)", "types": [ "bool" ], "variable": "$bypass_login_modal_shown_cookie" }, { "name": "since", "content": "9.0.16" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_cart_edit_redirect_suppress_notice", "file": "Features/CartEditingAtCheckout.php", "type": "filter", "doc": { "description": "Filters whether to suppress checkout is not available message when editing cart results in empty cart", "long_description": "", "tags": [ { "name": "since", "content": "3.14.0" }, { "name": "param", "content": "Whether to suppress the message", "types": [ "bool" ], "variable": "$supress_notice" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_cart_item_data_expanded", "file": "Model/OrderItem.php", "type": "filter", "doc": { "description": "Filter the order item data", "long_description": "", "tags": [ { "name": "param", "content": "The order item data", "types": [ "array" ], "variable": "$item_data" }, { "name": "param", "content": "The order item", "types": [ "\\WC_Order_Item" ], "variable": "$item" }, { "name": "since", "content": "7.2.1" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_cart_item_row_class", "file": "Model/CartItem.php", "type": "filter", "doc": { "description": "Filter the item row class", "long_description": "", "tags": [ { "name": "param", "content": "The filtered row class", "types": [ "string" ], "variable": "$woocommerce_filtered_cart_item_row_class" }, { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_cart_table_styles", "file": "Features/AbandonedCartRecovery.php", "type": "filter", "doc": { "description": "Filter the cart table styles", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "array" ], "variable": "$styles" }, { "name": "since", "content": "8.0.0" }, { "name": "since", "content": "10.1.0", "description": "Style attribute is deprecated." } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_cart_thumb_height", "file": "CartImageSizeAdder.php", "type": "filter", "doc": { "description": "Filter cart thumbnail height", "long_description": "0 indicates auto height", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The height of thumbnails in cart", "types": [ "int" ], "variable": "$thumb_width" } ], "long_description_html": "

0 indicates auto height

" }, "args": 1 }, { "name": "cfw_cart_thumb_width", "file": "CartImageSizeAdder.php", "type": "filter", "doc": { "description": "Filter cart thumbnail width", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The width of thumbnails in cart", "types": [ "int" ], "variable": "$thumb_width" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_check_create_account_by_default", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to check create account by default", "long_description": "", "tags": [ { "name": "param", "content": "Check create account by default", "types": [ "bool" ], "variable": "$check_create_account_by_default" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_checkbox_like_field_types", "file": "FormFieldAugmenter.php", "type": "filter", "doc": { "description": "The field type that are like checkboxes", "long_description": "", "tags": [ { "name": "since", "content": "7.0.10" }, { "name": "param", "content": "The field types", "types": [ "string[]" ], "variable": "$field_types" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_checkout_data", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter extra data available to JavaScript", "long_description": "Merge with default data. Even though we load this by default for non-checkout pages, we have to do this so that the data gets the default action values during AJAX updates", "tags": [ { "name": "param", "content": "The checkout data", "types": [ "array" ], "variable": "$data" }, { "name": "since", "content": "8.0.0" } ], "long_description_html": "

Merge with default data. Even though we load this by default for non-checkout pages, we have to do this so that the data gets the default action values during AJAX updates

" }, "args": 1 }, { "name": "cfw_compatibility_all_products_for_subscriptions_run_on_side_cart", "file": "Compatibility/Plugins/AllProductsForSubscriptions.php", "type": "filter", "doc": { "description": "Filter whether to load our customizations for All Products for Subscriptions on Side Cart", "long_description": "", "tags": [ { "name": "since", "content": "10.1.0" }, { "name": "param", "content": "Whether to load our customizations for All Products for Subscriptions on Side Cart", "types": [ "bool" ], "variable": "$load_on_side_cart" }, { "name": "return", "content": "" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_compatibility_free_gifts_for_woocommerce_prevent_redirect", "file": "Compatibility/Plugins/FreeGiftsforWooCommerce.php", "type": "filter", "doc": { "description": "Whether to prevent redirecting during add to cart when Free Gifts for WooComemrce is active", "long_description": "", "tags": [ { "name": "param", "content": "Whether to prevent redirecting during add to cart", "types": [ "bool" ], "variable": "$prevent_redirect" }, { "name": "return", "content": "" }, { "name": "since", "content": "10.1.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_compatibility_nexcessmu_prevent_disable_fragments", "file": "Compatibility/Plugins/NexcessMU.php", "type": "filter", "doc": { "description": "Prevent disabling fragments when Nexcess MU is active", "long_description": "", "tags": [ { "name": "param", "content": "Prevent disabling fragments", "types": [ "bool" ], "variable": "$prevent_disable_fragments" }, { "name": "return", "content": "" }, { "name": "since", "content": "10.1.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_compatibility_woocommerce_germanized_render_hook", "file": "Compatibility/Plugins/WooCommerceGermanized.php", "type": "filter", "doc": { "description": "Filter the rendering hook for WooCommerce Germanized compatibility", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "string" ], "variable": "$hook" }, { "name": "return", "content": "" }, { "name": "since", "content": "10.1.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_compatibility_woocommerce_germanized_render_priority", "file": "Compatibility/Plugins/WooCommerceGermanized.php", "type": "filter", "doc": { "description": "Filter the priority of the render hook for WooCommerce Germanized compatibility", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "int" ], "variable": "$priority" }, { "name": "return", "content": "" }, { "name": "since", "content": "10.1.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_compatibility_woocommerce_gift_cards_field_label", "file": "Compatibility/Plugins/WooCommerceGiftCards.php", "type": "filter", "doc": { "description": "Filter CheckoutWC WooCommerce Gift Cards field label", "long_description": "", "tags": [ { "name": "since", "content": "6.0.7" }, { "name": "param", "content": "Field label", "types": [ "string" ], "variable": "$label" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_compatibility_woocommerce_gift_cards_field_placeholder", "file": "Compatibility/Plugins/WooCommerceGiftCards.php", "type": "filter", "doc": { "description": "Filter CheckoutWC WooCommerce Gift Cards field placeholder", "long_description": "", "tags": [ { "name": "since", "content": "6.0.7" }, { "name": "param", "content": "Field placeholder", "types": [ "string" ], "variable": "$label" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_compatibility_woocommerce_gift_cards_heading_text", "file": "Compatibility/Plugins/WooCommerceGiftCards.php", "type": "filter", "doc": { "description": "Filter CheckoutWC WooCommerce Gift Cards Heading Text", "long_description": "", "tags": [ { "name": "since", "content": "6.0.7" }, { "name": "param", "content": "Heading text", "types": [ "string" ], "variable": "$heading_text" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_copy_pickup_details_to_order_notes", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Determine whether to copy pickup details to order notes", "long_description": "", "tags": [ { "name": "param", "content": "Whether to copy pickup details to order notes", "types": [ "bool" ], "variable": "$copy_pickup_details_to_order_notes" }, { "name": "since", "content": "7.7.2" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_crop_cart_thumbs", "file": "CartImageSizeAdder.php", "type": "filter", "doc": { "description": "Filter whether to crop cart thumbnails", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "True allows cropping", "types": [ "bool" ], "variable": "$crop" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_crop_order_bump_thumbs", "file": "CartImageSizeAdder.php", "type": "filter", "doc": { "description": "Filter whether to crop order bump thumbnails", "long_description": "", "tags": [ { "name": "since", "content": "11.0.1" }, { "name": "param", "content": "True allows cropping", "types": [ "bool" ], "variable": "$crop" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_crop_trust_badge_thumbs", "file": "TrustBadgeImageSizeAdder.php", "type": "filter", "doc": { "description": "Filter whether to crop cart thumbnails", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "True allows cropping", "types": [ "bool" ], "variable": "$crop" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_custom_css_properties", "file": "Managers/StyleManager.php", "type": "filter", "doc": { "description": "Filter the CSS custom property overrides", "long_description": "", "tags": [ { "name": "since", "content": "5.0.0" }, { "name": "param", "content": "The CSS custom properties", "types": [ "array" ], "variable": "$overrides" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_detected_gateways", "file": "Admin/Pages/ExpressCheckout.php", "type": "filter", "doc": { "description": "Filter detected gateways", "long_description": "", "tags": [ { "name": "since", "content": "9.0.0" }, { "name": "param", "content": "", "types": [ "array" ], "variable": "$gateways" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_disable_cart_editing", "file": "Model/CartItem.php", "type": "filter", "doc": { "description": "Filters whether to disable cart editing", "long_description": "", "tags": [ { "name": "param", "content": "Whether to disable cart editing", "types": [ "int" ], "variable": "$disable_cart_editing" }, { "name": "param", "content": "The cart item", "types": [ "array" ], "variable": "$cart_item" }, { "name": "param", "content": "The cart item key", "types": [ "string" ], "variable": "$cart_item_key" }, { "name": "since", "content": "7.1.7" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_disable_cart_quantity_prompt", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to disable cart quantity prompt", "long_description": "", "tags": [ { "name": "param", "content": "Disable cart quantity prompt", "types": [ "bool" ], "variable": "$disable_cart_quantity_prompt" }, { "name": "since", "content": "8.2.19" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_disable_cart_variation_editing", "file": "Model/CartItem.php", "type": "filter", "doc": { "description": "Filters whether to disable cart variation editing", "long_description": "", "tags": [ { "name": "param", "content": "Whether to disable cart editing", "types": [ "bool" ], "variable": "$disable_cart_variation_editing" }, { "name": "param", "content": "The cart item", "types": [ "array" ], "variable": "$cart_item" }, { "name": "param", "content": "The cart item key", "types": [ "string" ], "variable": "$cart_item_key" }, { "name": "param", "content": "The calling context", "types": [ "string" ], "variable": "$context" }, { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_disable_cart_variation_editing_checkout", "file": "Model/CartItem.php", "type": "filter", "doc": { "description": "Filters whether to disable cart variation editing", "long_description": "", "tags": [ { "name": "param", "content": "Whether to disable cart editing", "types": [ "bool" ], "variable": "$disable_cart_variation_editing_checkout" }, { "name": "param", "content": "The cart item", "types": [ "array" ], "variable": "$cart_item" }, { "name": "param", "content": "The cart item key", "types": [ "string" ], "variable": "$cart_item_key" }, { "name": "param", "content": "The calling context", "types": [ "string" ], "variable": "$context" }, { "name": "since", "content": "10.1.6" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_disable_email_domain_validation", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to disable email domain validation", "long_description": "", "tags": [ { "name": "param", "content": "Disable email domain validation", "types": [ "bool" ], "variable": "$disable_email_domain_validation" }, { "name": "since", "content": "8.2.26" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_disable_side_cart", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "Filter to disable side cart on specific pages/contexts", "long_description": "", "tags": [ { "name": "since", "content": "11.0.1" }, { "name": "param", "content": "Whether to disable side cart. Default false.", "types": [ "bool" ], "variable": "$disable" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_disable_side_cart_auto_open", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to auto open the side cart on add to cart", "long_description": "", "tags": [ { "name": "param", "content": "Disable side cart auto open", "types": [ "bool" ], "variable": "$disable_side_cart_auto_open" }, { "name": "since", "content": "7.1.5" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_disable_side_cart_item_quantity_control", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "Filters whether to disable cart item quantity control on the Side Cart", "long_description": "", "tags": [ { "name": "param", "content": "Whether to disable cart item quantity control on the Side Cart", "types": [ "bool" ], "variable": "$disable" }, { "name": "param", "content": "The cart item", "types": [ "array" ], "variable": "$cart_item" }, { "name": "param", "content": "The cart item key", "types": [ "string" ], "variable": "$cart_item_key" }, { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_disable_tracking_checkin", "file": "Stats/StatCollection.php", "type": "filter", "doc": { "description": "Filters whether to send a checkin.", "long_description": "", "tags": [ { "name": "since", "content": "7.8.8", "description": "d" }, { "name": "param", "content": "Whether to override the default behavior.", "types": [ "bool" ], "variable": "$override" }, { "name": "param", "content": "The home url.", "types": [ "string" ], "variable": "$home_url" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_disable_woocommerce_gift_cards_compatibility", "file": "Compatibility/Plugins/WooCommerceGiftCards.php", "type": "filter", "doc": { "description": "Filter whether to disable CheckoutWC WooCommerce Gift Cards compatibility class", "long_description": "", "tags": [ { "name": "since", "content": "5.3.5" }, { "name": "param", "content": "Whether to disable compatibility class", "types": [ "bool" ], "variable": "$disable" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_display_bump", "file": "Features/OrderBumps.php", "type": "filter", "doc": { "description": "Filter whether to display the bump", "long_description": "", "tags": [ { "name": "param", "content": "Whether to display the bump", "types": [ "bool" ], "variable": "$display_bump" }, { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_do_admin_bar", "file": "Admin/Pages/PageAbstract.php", "type": "filter", "doc": { "description": "Filters whether to show the admin bar button", "long_description": "", "tags": [ { "name": "param", "content": "Whether to show the admin bar button", "types": [ "bool" ], "variable": "$show" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_email_domain_valid", "file": "Action/ValidateEmailDomainAction.php", "type": "filter", "doc": { "description": "Filters whether to validate email domain", "long_description": "If you don't append dot to the domain, every domain will validate because it will fetch your local MX handler", "tags": [ { "name": "since", "content": "7.2.3" }, { "name": "param", "content": "Whether the email domain is valid", "types": [ "bool" ], "variable": "$valid" }, { "name": "param", "content": "The email domain", "types": [ "string" ], "variable": "$email_domain" }, { "name": "param", "content": "The email address", "types": [ "string" ], "variable": "$email_address" } ], "long_description_html": "

If you don't append dot to the domain, every domain will validate because it will fetch your local MX handler

" }, "args": 3 }, { "name": "cfw_email_exists", "file": "Action/AccountExistsAction.php", "type": "filter", "doc": { "description": "Filters whether an email address has an account", "long_description": "", "tags": [ { "name": "since", "content": "1.0.0" }, { "name": "param", "content": "Whether an email exists or not", "types": [ "bool" ], "variable": "$exists" }, { "name": "param", "content": "The email address we are checking", "types": [ "string" ], "variable": "$email" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_enable_account_exists_check", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to check whether an existing account matches provided email address", "long_description": "", "tags": [ { "name": "param", "content": "Enable account exists check when billing email field changed", "types": [ "bool" ], "variable": "$enable_account_exists_check" }, { "name": "since", "content": "5.3.7" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_enable_editable_admin_shipping_phone_field", "file": "Admin/ShippingPhoneController.php", "type": "filter", "doc": { "description": "Filter whether to enable editable shipping phone field in admin", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "True show editable field, false show label", "types": [ "bool" ], "variable": "$enable_editable_admin_phone_field" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_enable_field_persistence", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to enable field peristence with Garlic.js", "long_description": "", "tags": [ { "name": "param", "content": "Enable field persistence", "types": [ "bool" ], "variable": "$cfw_enable_field_persistence" }, { "name": "since", "content": "7.1.10" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_enable_fullname_field", "file": "AddressFieldsAugmenter.php", "type": "filter", "doc": { "description": "Filter whether to enable full name field", "long_description": "", "tags": [ { "name": "since", "content": "7.1.0" }, { "name": "param", "content": "Whether to enable full name field", "types": [ "array" ], "variable": "$enable_fullname_field" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_enable_separate_address_1_fields", "file": "AddressFieldsAugmenter.php", "type": "filter", "doc": { "description": "Filter whether to enable separate address 1 fields", "long_description": "", "tags": [ { "name": "since", "content": "7.1.0" }, { "name": "param", "content": "Whether to enable separate address 1 fields", "types": [ "array" ], "variable": "$enable_separate_address_1_fields" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_enable_smartystreets_integration", "file": "Features/SmartyStreets.php", "type": "filter", "doc": { "description": "Whether to enable Smarty integration", "long_description": "", "tags": [ { "name": "since", "content": "5.2.1" }, { "name": "param", "content": "Whether to enable Smarty integration", "types": [ "bool" ], "variable": "$enable" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_enable_zip_autocomplete", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to enable zip autocomplete", "long_description": "", "tags": [ { "name": "param", "content": "Enable zip autocomplete", "types": [ "bool" ], "variable": "$enable_zip_autocomplete" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_estimated_pickup_time", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filters the pickup location estimated time", "long_description": "NOTE: Use cfw_pickup_times to extend the list of available pickup times", "tags": [ { "name": "param", "content": "The estimated time", "types": [ "string" ], "variable": "$pickup_time" }, { "name": "since", "content": "7.5.0" } ], "long_description_html": "

NOTE: Use cfw_pickup_times to extend the list of available pickup times

" }, "args": 2 }, { "name": "cfw_event_object", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter cfw_event_object array", "long_description": "Localized data available via DataService", "tags": [ { "name": "param", "content": "The data", "types": [ "array" ], "variable": "$cfw_event_object" }, { "name": "since", "content": "1.0.0" } ], "long_description_html": "

Localized data available via DataService

" }, "args": 1 }, { "name": "cfw_failed_login_error_message", "file": "Action/LogInAction.php", "type": "filter", "doc": { "description": "Filters failed login error message", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The error message", "types": [ "string" ], "variable": "$error" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_fetchify_address_autocomplete_countries", "file": "Features/FetchifyAddressAutocomplete.php", "type": "filter", "doc": { "description": "Filter list of shipping country restrictions for Google Maps address autocomplete", "long_description": "", "tags": [ { "name": "param", "content": "List of country restrictions for Google Maps address autocomplete", "types": [ "array" ], "variable": "$address_autocomplete_shipping_countries" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_fetchify_address_autocomplete_default_country", "file": "Features/FetchifyAddressAutocomplete.php", "type": "filter", "doc": { "description": "Filter Fetchify address autocomplete default country", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "string" ], "variable": "$default_country" }, { "name": "since", "content": "5.3.2" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_fetchify_address_autocomplete_enable_geolocation", "file": "Features/FetchifyAddressAutocomplete.php", "type": "filter", "doc": { "description": "Filter whether to enable geolocation", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "bool" ], "variable": "$enable_geolocation" }, { "name": "since", "content": "5.3.2" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_fetchify_search_placeholder", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter the fetchify search placeholder", "long_description": "", "tags": [ { "name": "param", "content": "Fetchify search placeholder", "types": [ "string" ], "variable": "$fetchify_default_placeholder" }, { "name": "since", "content": "8.2.3" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_field_data_persistence_excludes", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter list of field persistence service excludes", "long_description": "", "tags": [ { "name": "param", "content": "List of field persistence service excludes", "types": [ "array" ], "variable": "$field_persistence_excludes" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_form_field_suppress_optional_in_placeholder", "file": "FormFieldAugmenter.php", "type": "filter", "doc": { "description": "Whether to suppress 'optional' from field placeholder", "long_description": "", "tags": [ { "name": "since", "content": "10.1.13" }, { "name": "param", "content": "Whether to suppress optional from field placeholder", "types": [ "bool" ], "variable": "$append" }, { "name": "param", "content": "The key.", "types": [ "mixed" ], "variable": "$key" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_get_data_clear_notices", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filters whether to clear notices when gathering data", "long_description": "", "tags": [ { "name": "param", "content": "Clear notices", "types": [ "bool" ], "variable": "$clear_notices" }, { "name": "since", "content": "9.0.36" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_google_address_autocomplete_type", "file": "Features/GoogleAddressAutocomplete.php", "type": "filter", "doc": { "description": "Filter Google address autocomplete type", "long_description": "", "tags": [ { "name": "since", "content": "7.3.0" }, { "name": "param", "content": "Google address autocomplete type", "types": [ "string" ], "variable": "$autocomplete_type" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_google_font_configurations", "file": "Managers/StyleManager.php", "type": "filter", "doc": { "description": "Filter the Google Font configurations before generating the URL.", "long_description": "This is the primary filter for customizing font loading. You can add, remove, or modify font configurations.", "tags": [ { "name": "param", "content": "An associative array of font configurations, keyed by the font family name (e.g., 'Open Sans'). Example: $font_configs[ $font_name ] = array( 'family' => $font_name, 'weights' => array( '400', '700' ), 'italic' => true, );", "types": [ "array" ], "variable": "$font_configs" }, { "name": "since", "content": "10.1.16" } ], "long_description_html": "

This is the primary filter for customizing font loading. You can add, remove, or modify font configurations.

" }, "args": 1 }, { "name": "cfw_google_font_display", "file": "Managers/StyleManager.php", "type": "filter", "doc": { "description": "Filter the font-display property for the Google Fonts URL.", "long_description": "", "tags": [ { "name": "since", "content": "10.1.16" }, { "name": "param", "content": "The CSS font-display property. Accepts 'auto', 'block', 'swap', 'fallback', 'optional'.", "types": [ "string" ], "variable": "$display" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_google_maps_compatibility_mode", "file": "Features/GoogleAddressAutocomplete.php", "type": "filter", "doc": { "description": "Whether to enable Google Maps compatibility mode", "long_description": "", "tags": [ { "name": "since", "content": "4.3.7" }, { "name": "param", "content": "Whether to enable Google Maps compatibility mode", "types": [ "bool" ], "variable": "$compatibility_mode" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_google_maps_language_code", "file": "Features/GoogleAddressAutocomplete.php", "type": "filter", "doc": { "description": "Filter Google Maps language code", "long_description": "", "tags": [ { "name": "since", "content": "4.3.7" }, { "name": "param", "content": "Google Maps language code", "types": [ "string" ], "variable": "$lanugage_code" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_hide_bump_if_offer_product_in_cart", "file": "Model/Bumps/BumpAbstract.php", "type": "filter", "doc": { "description": "Filters whether to show a bump if the offer product is already in the cart", "long_description": "", "tags": [ { "name": "since", "content": "8.2.18" }, { "name": "param", "content": "Whether to show a bump if the offer product is already in the cart", "types": [ "bool" ], "variable": "$show_bump_if_offer_product_in_cart" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_hide_optional_fields_behind_links", "file": "Features/HideOptionalAddressFields.php", "type": "filter", "doc": { "description": "Filters whether to hide the optional address line 2 field behind a link.", "long_description": "", "tags": [ { "name": "since", "content": "7.2.1" }, { "name": "param", "content": "Whether to hide the optional address line 2 field behind a link.", "types": [ "bool" ], "variable": "$hide" }, { "name": "param", "content": "The fieldset.", "types": [ "string" ], "variable": "$fieldset" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_hide_optional_fiscal_code", "file": "Compatibility/Plugins/Fattureincloud.php", "type": "filter", "doc": { "description": "Filters whether to hide optional fiscal code field generated by Fatture in Cloud plugin", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "True hide, false show", "types": [ "bool" ], "variable": "$hide" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_highlighted_countries", "file": "Compatibility/Plugins/WooCommerceCore.php", "type": "filter", "doc": { "description": "The list of highlighted countries", "long_description": "", "tags": [ { "name": "since", "content": "6.0.0" }, { "name": "param", "content": "The highlighted countries", "types": [ "array" ], "variable": "$highlighted_countries" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_international_phone_field_placeholder_mode", "file": "Features/InternationalPhoneField.php", "type": "filter", "doc": { "description": "Filter international phone field placeholder mode", "long_description": "", "tags": [ { "name": "since", "content": "8.2.19" }, { "name": "param", "content": "", "types": [ "string" ], "variable": "$mode" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_invalid_full_name_validation_error_message", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter the invalid fullname error message", "long_description": "", "tags": [ { "name": "param", "content": "Invalid fullname error message", "types": [ "string" ], "variable": "$invalid_fullname_message" }, { "name": "since", "content": "6.2.4" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_invalid_phone_validation_error_message", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter the invalid phone number error message", "long_description": "", "tags": [ { "name": "param", "content": "Invalid phone number error message", "types": [ "string" ], "variable": "$invalid_phone_number_message" }, { "name": "since", "content": "5.3.5" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_is_cart_bump_valid", "file": "Model/Bumps/BumpAbstract.php", "type": "filter", "doc": { "description": "Filters whether the bump is valid", "long_description": "", "tags": [ { "name": "param", "content": "Whether the categories bump in the cart is still valid", "types": [ "string" ], "variable": "$is_cart_bump_valid" }, { "name": "since", "content": "6.3.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_klaviyo_output_hook", "file": "Compatibility/Plugins/Klaviyo.php", "type": "filter", "doc": { "description": "Where to output Klaviyo checkboxes", "long_description": "", "tags": [ { "name": "since", "content": "5.1.2" }, { "name": "param", "content": "Where to output the checkbox.", "types": [ "string" ], "variable": "$location" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_legacy_suppress_php_errors_output", "file": "PhpErrorOutputSuppressor.php", "type": "filter", "doc": { "description": "Filters whether to suppress PHP errors output.", "long_description": "", "tags": [ { "name": "since", "content": "5.0.0" }, { "name": "param", "content": "Whether to suppress PHP errors output.", "types": [ "bool" ], "variable": "$suppress" }, { "name": "return", "content": "" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_link_cart_items", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filters whether to link cart items to products", "long_description": "", "tags": [ { "name": "param", "content": "Link cart items to products", "types": [ "bool" ], "variable": "$link_cart_items" }, { "name": "since", "content": "1.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_load_checkout_template", "file": "Loaders/Content.php", "type": "filter", "doc": { "description": "Filters whether to load checkout template", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "True load, false don't load", "types": [ "bool" ], "variable": "$load" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_load_order_pay_template", "file": "Loaders/Content.php", "type": "filter", "doc": { "description": "Filters whether to load order pay template", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "True load, false don't load", "types": [ "bool" ], "variable": "$load" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_load_order_received_template", "file": "Loaders/Content.php", "type": "filter", "doc": { "description": "Filters whether to load order received template", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "True load, false don't load", "types": [ "bool" ], "variable": "$load" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_load_tabs", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to load tabs", "long_description": "", "tags": [ { "name": "param", "content": "Load tabs", "types": [ "bool" ], "variable": "$load_tabs" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_local_pickup_disable_pickup_option", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filters whether the pickup option should be disabled", "long_description": "", "tags": [ { "name": "param", "content": "Whether the pickup option should be disabled", "types": [ "bool" ], "variable": "$disable_pickup_option" }, { "name": "since", "content": "8.1.6" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_local_pickup_disable_shipping_option", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filters whether the shipping option should be disabled", "long_description": "", "tags": [ { "name": "param", "content": "Whether the shipping option should be disabled", "types": [ "bool" ], "variable": "$disable_shipping_option" }, { "name": "since", "content": "8.1.6" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_local_pickup_option_label", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filters the local pickup option label", "long_description": "", "tags": [ { "name": "param", "content": "The pickup option label", "types": [ "string" ], "variable": "$pickup_option_label" }, { "name": "since", "content": "7.3.1" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_local_pickup_shipping_option_label", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filters the local pickup shipping option label", "long_description": "", "tags": [ { "name": "param", "content": "The shipping option label", "types": [ "string" ], "variable": "$ship_option_label" }, { "name": "since", "content": "7.3.1" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_local_pickup_thank_you_address", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filter the local pickup address shown to customers on the thank you page", "long_description": "", "tags": [ { "name": "param", "content": "The local pickup address shown to customers", "types": [ "string" ], "variable": "$address" }, { "name": "since", "content": "7.3.2" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_local_pickup_use_default_billing_address_as_default_shipping_address", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filters whether to use billing address as shipping address when local pickup is selected", "long_description": "", "tags": [ { "name": "since", "content": "9.1.2" }, { "name": "param", "content": "Whether to use billing address as shipping address when local pickup is selected", "types": [ "bool" ], "variable": "$use_default_billing_address_as_default_shipping_address" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_local_pickup_use_google_address_link", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Whether to link the local pickup address to Google Maps for directions", "long_description": "", "tags": [ { "name": "param", "content": "Whether to link the local pickup address to Google Maps", "types": [ "bool" ], "variable": "$link" }, { "name": "since", "content": "7.3.2" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_locale_prefix", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter locale prefix", "long_description": "", "tags": [ { "name": "param", "content": "Locale prefix", "types": [ "string" ], "variable": "$locale" }, { "name": "since", "content": "9.1.5" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_non_floating_label_field_types", "file": "FormFieldAugmenter.php", "type": "filter", "doc": { "description": "The non-floating label field types", "long_description": "", "tags": [ { "name": "since", "content": "6.2.3" }, { "name": "param", "content": "The nonfloating label field types", "types": [ "array" ], "variable": "$field_types" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_offer_product_data", "file": "Action/ProcessOfferPaymentAction.php", "type": "filter", "doc": { "description": "Filter offer product data before payment processing", "long_description": "", "tags": [ { "name": "since", "content": "10.4.0" }, { "name": "param", "content": "Product data array.", "types": [ "array" ], "variable": "$product_data" }, { "name": "param", "content": "Parent order.", "types": [ "\\WC_Order" ], "variable": "$order" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_offer_should_create_child_order", "file": "Features/OneClick/OfferOrderManager.php", "type": "filter", "doc": { "description": "Filter whether to create a child order for the offer", "long_description": "", "tags": [ { "name": "param", "content": "Whether to create a child order", "types": [ "bool" ], "variable": "$create_child_order" }, { "name": "param", "content": "The parent order", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "Product data", "types": [ "array" ], "variable": "$product_data" }, { "name": "since", "content": "7.0.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_one_click_supported_gateways", "file": "Features/OneClick/GatewayRegistry.php", "type": "filter", "doc": { "description": "Filter supported one-click upsell gateways", "long_description": "Allows third parties to register gateway support. Mirrors CartFlows' cartflows_offer_supported_payment_gateways filter.", "tags": [ { "name": "since", "content": "10.4.0" }, { "name": "param", "content": "Gateway array keyed by WooCommerce gateway ID.", "types": [ "array" ], "variable": "$supported_gateways" } ], "long_description_html": "

Allows third parties to register gateway support. Mirrors CartFlows' cartflows_offer_supported_payment_gateways filter.

" }, "args": 1 }, { "name": "cfw_optional_address_2_link_text", "file": "Features/HideOptionalAddressFields.php", "type": "filter", "doc": { "description": "Filters the link text for adding the optional address line 2 field.", "long_description": "", "tags": [ { "name": "since", "content": "9.0.17" }, { "name": "param", "content": "The link text.", "types": [ "string" ], "variable": "$address_2_link_text" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_optional_company_link_text", "file": "Features/HideOptionalAddressFields.php", "type": "filter", "doc": { "description": "Filters the link text for adding the optional address line 2 field.", "long_description": "", "tags": [ { "name": "since", "content": "9.0.17" }, { "name": "param", "content": "The link text.", "types": [ "string" ], "variable": "$company_link_text" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_order_bump_captured_revenue", "file": "Model/Bumps/BumpAbstract.php", "type": "filter", "doc": { "description": "Filter the captured revenue", "long_description": "", "tags": [ { "name": "param", "content": "The new captured revenue", "types": [ "float" ], "variable": "$new_revenue" }, { "name": "param", "content": "The bump", "types": [ "\\BumpInterface" ], "variable": "$bump" }, { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_order_bump_get_price", "file": "Model/Bumps/BumpAbstract.php", "type": "filter", "doc": { "description": "Filter the order bump price.", "long_description": "", "tags": [ { "name": "param", "content": "The price of the order bump.", "types": [ "float" ], "variable": "$price" }, { "name": "param", "content": "The context of the price.", "types": [ "string" ], "variable": "$context" }, { "name": "param", "content": "The order bump object.", "types": [ "\\BumpInterface" ], "variable": "$order_bump" }, { "name": "since", "content": "5.0.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_order_bump_get_price_context", "file": "Features/OrderBumps.php", "type": "filter", "doc": { "description": "Filter the context for the bump price", "long_description": "", "tags": [ { "name": "param", "content": "The context for the bump price", "types": [ "string" ], "variable": "$context" }, { "name": "param", "content": "The cart item", "types": [ "array" ], "variable": "$cart_item" }, { "name": "param", "content": "The bump", "types": [ "\\BumpInterface" ], "variable": "$bump" }, { "name": "since", "content": "8.1.6" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_order_bump_thumb_height", "file": "CartImageSizeAdder.php", "type": "filter", "doc": { "description": "Filter order bump thumbnail height", "long_description": "0 indicates auto height", "tags": [ { "name": "since", "content": "11.0.1" }, { "name": "param", "content": "The height of thumbnails in order bumps", "types": [ "int" ], "variable": "$thumb_height" } ], "long_description_html": "

0 indicates auto height

" }, "args": 1 }, { "name": "cfw_order_bump_thumb_width", "file": "CartImageSizeAdder.php", "type": "filter", "doc": { "description": "Filter order bump thumbnail width", "long_description": "", "tags": [ { "name": "since", "content": "11.0.1" }, { "name": "param", "content": "The width of thumbnails in order bumps", "types": [ "int" ], "variable": "$thumb_width" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_order_bump_upsell_quantity_to_replace", "file": "Model/Bumps/BumpAbstract.php", "type": "filter", "doc": { "description": "The max number of items that upsell can replace (-1 is unlimited)", "long_description": "", "tags": [ { "name": "since", "content": "7.6.1" }, { "name": "param", "content": "", "types": [ "int" ], "variable": "$replace_up_to_quantity" }, { "name": "param", "content": "", "types": [ "\\BumpInterface" ], "variable": "$bump" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_order_email_pickup_address", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filter the local pickup address shown in order emails", "long_description": "", "tags": [ { "name": "param", "content": "The formatted pickup address", "types": [ "string" ], "variable": "$address" }, { "name": "param", "content": "The raw pickup address", "types": [ "string" ], "variable": "$raw_address" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "since", "content": "10.2.8" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_order_item_row_class", "file": "Model/OrderItem.php", "type": "filter", "doc": { "description": "Filter the order item row class", "long_description": "", "tags": [ { "name": "param", "content": "The order item row class", "types": [ "string" ], "variable": "$row_class" }, { "name": "param", "content": "The order item", "types": [ "\\WC_Order_Item" ], "variable": "$item" }, { "name": "since", "content": "7.2.1" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_order_item_thumbnail", "file": "Model/OrderItem.php", "type": "filter", "doc": { "description": "Filter the order item thumbnail", "long_description": "", "tags": [ { "name": "param", "content": "The order item thumbnail", "types": [ "string" ], "variable": "$thumbnail" }, { "name": "param", "content": "The order item", "types": [ "\\WC_Order_Item" ], "variable": "$item" }, { "name": "since", "content": "7.2.1" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_order_updates_heading", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filter the pickup instructions", "long_description": "", "tags": [ { "name": "param", "content": "The pickup instructions", "types": [ "string" ], "variable": "$instructions" }, { "name": "param", "content": "The order", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "since", "content": "7.3.2" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_parsley_locale", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter Parsley validation service locale", "long_description": "", "tags": [ { "name": "param", "content": "Parsley validation service locale", "types": [ "string" ], "variable": "$locale" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_payment_gateway_field_html_{$kp->id}", "file": "Compatibility/Gateways/KlarnaPayment.php", "type": "filter", "doc": { "description": "Filters klarna payment gateway output", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "The gateway output", "types": [ "string" ], "variable": "$output" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_payment_gateway_{$kp->id}_content", "file": "Compatibility/Gateways/KlarnaPayment.php", "type": "filter", "doc": { "description": "Filters whether to show custom klarna payment box HTML", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "Whether to show custom payment box HTML", "types": [ "bool" ], "variable": "$show" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_phone_field_highlighted_countries", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter intl-tel-input preferred countries", "long_description": "", "tags": [ { "name": "param", "content": "List of preferred countries", "types": [ "array" ], "variable": "$phone_field_preferred_countries" }, { "name": "since", "content": "8.2.22" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_pickup_instructions_text", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filters pickup instructions text", "long_description": "", "tags": [ { "name": "param", "content": "Thank you page order updates text", "types": [ "string" ], "variable": "$pickup_instructions_text" }, { "name": "since", "content": "7.3.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_pickup_times", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filters the pickup times", "long_description": "", "tags": [ { "name": "param", "content": "The pickup times", "types": [ "array" ], "variable": "$pickup_times" }, { "name": "since", "content": "7.3.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_promo_code_apply_button_label", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filters promo code button label", "long_description": "", "tags": [ { "name": "param", "content": "Promo code button label", "types": [ "string" ], "variable": "$promo_code_button_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_promo_code_label", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filters promo code label", "long_description": "", "tags": [ { "name": "param", "content": "Promo code label", "types": [ "string" ], "variable": "$promo_code_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_promo_code_placeholder", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filters promo code placeholder", "long_description": "", "tags": [ { "name": "param", "content": "Promo code placeholder", "types": [ "string" ], "variable": "$promo_code_placeholder" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_promo_code_toggle_link_text", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filters promo code toggle link text", "long_description": "", "tags": [ { "name": "param", "content": "Filters promo code toggle link text", "types": [ "string" ], "variable": "$promo_code_toggle_link_text" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_reload_checkout", "file": "Action/UpdateCheckoutAction.php", "type": "filter", "doc": { "description": "Filters whether to reload checkout", "long_description": "", "tags": [ { "name": "param", "content": "Whether to reload checkout", "types": [ "bool" ], "variable": "$reload_checkout" }, { "name": "since", "content": "10.3.9" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_remove_coupon_response", "file": "Action/RemoveCouponAction.php", "type": "filter", "doc": { "description": "Filters remove coupon action response object", "long_description": "", "tags": [ { "name": "since", "content": "3.14.0" }, { "name": "param", "content": "The response object", "types": [ "array" ], "variable": "$response" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_restricted_post_types_count_args", "file": "Admin/Pages/Premium/AbandonedCartRecovery.php", "type": "filter", "doc": { "description": "Filters the arguments used to count emails", "long_description": "", "tags": [ { "name": "param", "content": "The arguments.", "types": [ "array" ], "variable": "$args" }, { "name": "return", "content": "" }, { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_run_woocommerce_cart_actions", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "Filter to enable or disable the WooCommerce cart actions", "long_description": "", "tags": [ { "name": "since", "content": "8.0.0" }, { "name": "param", "content": "", "types": [ "bool" ], "variable": "$cfw_run_woocommerce_cart_actions" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_select_field_options", "file": "FormFieldAugmenter.php", "type": "filter", "doc": { "description": "Filters the select field options for edge cases", "long_description": "", "tags": [ { "name": "param", "content": "The select field options", "types": [ "array" ], "variable": "$options" }, { "name": "param", "content": "The field arguments", "types": [ "array" ], "variable": "$args" }, { "name": "param", "content": "The field key", "types": [ "string" ], "variable": "$key" }, { "name": "since", "content": "7.4.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_selected_tab", "file": "Admin/TabNavigation.php", "type": "filter", "doc": { "description": "Filters the selected_tab", "long_description": "Represents the currently selected tab in a user interface.", "tags": [ { "name": "since", "content": "9.0.0" }, { "name": "param", "content": "The currently selected settings tab.", "types": [ "string" ], "variable": "$selected_tab" } ], "long_description_html": "

Represents the currently selected tab in a user interface.

" }, "args": 1 }, { "name": "cfw_session_expired_target_element", "file": "Action/UpdateCheckoutAction.php", "type": "filter", "doc": { "description": "Filters which element to update with session expired notice", "long_description": "", "tags": [ { "name": "param", "content": "Element to update with session expired notice", "types": [ "string" ], "variable": "$element" }, { "name": "since", "content": "5.2.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_shipping_bar_data", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "Filters the free shipping data when no free shipping methods are available", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "array" ], "variable": "$data" }, { "name": "since", "content": "7.0.5" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_shipping_method_heading", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter the shipping methods heading", "long_description": "", "tags": [ { "name": "param", "content": "Shipping methods heading", "types": [ "string" ], "variable": "$shipping_methods_heading" }, { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_cart_item_discount", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filters whether to show cart item discount on cart item", "long_description": "", "tags": [ { "name": "param", "content": "Show cart item discount on cart item", "types": [ "bool" ], "variable": "$show_cart_item_discount" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_klarna_checkout_express_button", "file": "Compatibility/Gateways/KlarnaCheckout.php", "type": "filter", "doc": { "description": "Whether to show the Klarna Checkout button", "long_description": "", "tags": [ { "name": "since", "content": "7.1.7" }, { "name": "param", "content": "Whether to show the Klarna Checkout button", "types": [ "bool" ], "variable": "$show_button" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_pickup_location_in_email", "file": "Features/LocalPickup.php", "type": "filter", "doc": { "description": "Filter whether to show pickup location info in order emails", "long_description": "", "tags": [ { "name": "param", "content": "Whether to show pickup location info", "types": [ "bool" ], "variable": "$show_pickup_info" }, { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "The email object", "types": [ "\\WC_Email" ], "variable": "$email" }, { "name": "since", "content": "10.2.8" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_side_cart_enable_continue_shopping_button", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filters whether to enable continue shopping button in side cart", "long_description": "", "tags": [ { "name": "param", "content": "Whether to enable continue shopping button in side cart", "types": [ "bool" ], "variable": "$enable_continue_shopping_btn" }, { "name": "since", "content": "7.7.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_side_cart_event_object", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter cfw_event_object array", "long_description": "Localized data available via DataService", "tags": [ { "name": "param", "content": "The data", "types": [ "array" ], "variable": "$cfw_event_object" }, { "name": "since", "content": "1.0.0" } ], "long_description_html": "

Localized data available via DataService

" }, "args": 1 }, { "name": "cfw_side_cart_free_shipping_progress_bar_amount_remaining_message_format", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "Filter the message format for the amount remaining for free shipping", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "string" ], "variable": "$amount_remaining_message" }, { "name": "since", "content": "7.3.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_side_cart_free_shipping_progress_bar_free_shipping_message", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "Filter the message displayed when the cart qualifies for free shipping.", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "string" ], "variable": "$free_shipping_message" }, { "name": "since", "content": "7.3.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_side_cart_free_shipping_threshold", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "Filters the free shipping threshold amount", "long_description": "", "tags": [ { "name": "param", "content": "The free shipping threshold amount", "types": [ "float" ], "variable": "$threshold" }, { "name": "since", "content": "8.1.12" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_side_cart_icon", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "The contents of the side cart icon file", "long_description": "", "tags": [ { "name": "since", "content": "8.2.7" }, { "name": "param", "content": "The contents of the side cart icon file", "types": [ "string" ], "variable": "$path" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_side_cart_icon_file_path", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "The path to the side cart icon file", "long_description": "", "tags": [ { "name": "since", "content": "8.2.7" }, { "name": "param", "content": "The path to the side cart icon file", "types": [ "string" ], "variable": "$path" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_side_cart_shipping_bar_data_exclude_discounts", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "Filters whether to exclude discounts from the subtotal when calculating the free shipping bar", "long_description": "", "tags": [ { "name": "param", "content": "Whether to exclude discounts from the subtotal when calculating the free shipping bar", "types": [ "bool" ], "variable": "$exclude_discounts" }, { "name": "since", "content": "7.10.2" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_side_cart_show_total", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filters whether to show shipping and tax totals in side cart", "long_description": "", "tags": [ { "name": "param", "content": "Whether to show shipping and tax totals in side cart", "types": [ "bool" ], "variable": "$show_total" }, { "name": "since", "content": "7.7.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_skip_bump_cart_item_discount_html", "file": "Features/OrderBumps.php", "type": "filter", "doc": { "description": "Filter to determine if cart item discount HTML should be skipped", "long_description": "", "tags": [ { "name": "param", "content": "Whether to skip this cart item discount HTML", "types": [ "bool" ], "variable": "$skip" }, { "name": "param", "content": "The cart item data", "types": [ "array" ], "variable": "$cart_item" }, { "name": "since", "content": "10.2.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_skip_bump_cart_item_pricing", "file": "Features/OrderBumps.php", "type": "filter", "doc": { "description": "Filter to determine if cart item pricing should be skipped", "long_description": "", "tags": [ { "name": "param", "content": "Whether to skip this cart item", "types": [ "bool" ], "variable": "$skip" }, { "name": "param", "content": "The cart item data", "types": [ "array" ], "variable": "$cart_item" }, { "name": "since", "content": "10.2.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_smarty_address_validation_address", "file": "Action/SmartyStreetsAddressValidationAction.php", "type": "filter", "doc": { "description": "Filter the address before it's sent to SmartyStreets", "long_description": "", "tags": [ { "name": "param", "content": "The address to be sent to SmartyStreets", "types": [ "array" ], "variable": "$address" }, { "name": "since", "content": "7.10.3" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_smarty_use_zip4", "file": "Action/SmartyStreetsAddressValidationAction.php", "type": "filter", "doc": { "description": "Filter whether to use the zip4 code", "long_description": "", "tags": [ { "name": "param", "content": "Whether to use the zip4 code", "types": [ "bool" ], "variable": "$use_zip4" }, { "name": "since", "content": "8.2.26" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_square_payment_requests_ignore_shipping_phone", "file": "Compatibility/Gateways/Square.php", "type": "filter", "doc": { "description": "Filters whether to override Stripe payment request button heights", "long_description": "", "tags": [ { "name": "since", "content": "4.3.3" }, { "name": "param", "content": "Whether to ignore shipping phone requirement during payment requests", "types": [ "bool" ], "variable": "$allow" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_stripe_force_checkout_express_checkout", "file": "Compatibility/Gateways/Stripe.php", "type": "filter", "doc": { "description": "Filter to force enable express checkout on checkout page", "long_description": "Useful when Stripe settings are misconfigured or empty", "tags": [ { "name": "since", "content": "10.3.10" }, { "name": "param", "content": "Whether to force enable express checkout", "types": [ "bool" ], "variable": "$force_enable" } ], "long_description_html": "

Useful when Stripe settings are misconfigured or empty

" }, "args": 1 }, { "name": "cfw_stripe_payment_requests_ignore_shipping_phone", "file": "Compatibility/Gateways/Stripe.php", "type": "filter", "doc": { "description": "Filters whether to override Stripe payment request button heights", "long_description": "", "tags": [ { "name": "since", "content": "4.3.3" }, { "name": "param", "content": "Whether to ignore shipping phone requirement during payment requests", "types": [ "bool" ], "variable": "$allow" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_suppress_add_to_cart_notices", "file": "Compatibility/Plugins/WooCommerceCore.php", "type": "filter", "doc": { "description": "Filters whether to suppress add to cart notices at checkout", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "True suppress, false allow", "types": [ "bool" ], "variable": "$supress_notices" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_template_global_params", "file": "Loaders/LoaderAbstract.php", "type": "filter", "doc": { "description": "Filters global template parameters available to templates", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The global template parameters", "types": [ "array" ], "variable": "$global_params" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_page_map_address", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter thank you page map address", "long_description": "", "tags": [ { "name": "param", "content": "The address for the map", "types": [ "array" ], "variable": "$address" }, { "name": "param", "content": "The order", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "since", "content": "5.3.9" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_theme_color_settings", "file": "Admin/Pages/Appearance.php", "type": "filter", "doc": { "description": "Filters the theme color settings.", "long_description": "", "tags": [ { "name": "param", "content": "The theme color settings.", "types": [ "array" ], "variable": "$color_settings" }, { "name": "since", "content": "5.1.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_trust_badge_thumb_height", "file": "TrustBadgeImageSizeAdder.php", "type": "filter", "doc": { "description": "Filter cart thumbnail height", "long_description": "0 indicates auto height", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The height of thumbnails in cart", "types": [ "int" ], "variable": "$thumb_width" } ], "long_description_html": "

0 indicates auto height

" }, "args": 1 }, { "name": "cfw_trust_badge_thumb_width", "file": "TrustBadgeImageSizeAdder.php", "type": "filter", "doc": { "description": "Filter cart thumbnail width", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The width of thumbnails in cart", "types": [ "int" ], "variable": "$thumb_width" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_trust_badges_output_action", "file": "Features/TrustBadges.php", "type": "filter", "doc": { "description": "Filter the action to output the trust badges", "long_description": "", "tags": [ { "name": "since", "content": "9.0.0" }, { "name": "param", "content": "The action to output the trust badges", "types": [ "string" ], "variable": "$action" }, { "name": "param", "content": "The position of the trust badges", "types": [ "string" ], "variable": "$position" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_typescript_compatibility_classes_and_params", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter TypeScript compatibility classes and params", "long_description": "", "tags": [ { "name": "param", "content": "TypeScript compatibility classes and params", "types": [ "array" ], "variable": "$compatibility" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_unsubscribe_successful_message", "file": "Features/AbandonedCartRecovery.php", "type": "filter", "doc": { "description": "Filter the message shown when a user unsubscribes from cart reminder emails.", "long_description": "", "tags": [ { "name": "since", "content": "9.0.0" }, { "name": "param", "content": "The message to show.", "types": [ "string" ], "variable": "$unsubscribe_notice" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_update_checkout_redirect", "file": "Action/UpdateCheckoutAction.php", "type": "filter", "doc": { "description": "Filters whether to redirect the checkout page during refresh", "long_description": "", "tags": [ { "name": "param", "content": "Boolean false means don't redirect, string means redirect to URL", "types": [ "bool", "string" ], "variable": "$" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_update_payment_methods", "file": "Action/UpdateCheckoutAction.php", "type": "filter", "doc": { "description": "Filters payment methods during update_checkout refresh", "long_description": "", "tags": [ { "name": "param", "content": "The payment methods container and content", "types": [ "string" ], "variable": "$" }, { "name": "since", "content": "4.0.2" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_updates_manager_home_url", "file": "Managers/UpdatesManager.php", "type": "filter", "doc": { "description": "Filters the home URL.", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "The complete home URL including scheme and path.", "types": [ "string" ], "variable": "$url" }, { "name": "param", "content": "Path relative to the home URL. Blank string if no path is specified.", "types": [ "string" ], "variable": "$path" }, { "name": "param", "content": "Scheme to give the home URL context. Accepts 'http', 'https', 'relative', 'rest', or null.", "types": [ "string", "null" ], "variable": "$orig_scheme" }, { "name": "param", "content": "Site ID, or null for the current site.", "types": [ "int", "null" ], "variable": "$blog_id" } ], "long_description_html": "" }, "args": 4 }, { "name": "cfw_validate_required_registration", "file": "Managers/AssetManager.php", "type": "filter", "doc": { "description": "Filter whether to validate required registration", "long_description": "", "tags": [ { "name": "param", "content": "Validate required registration", "types": [ "bool" ], "variable": "$validate_required_registration" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_validate_update_order_review_nonce", "file": "Action/UpdateCheckoutAction.php", "type": "filter", "doc": { "description": "Filters whether to validate nonce for update order review", "long_description": "", "tags": [ { "name": "param", "content": "Whether to validate nonce for update order review", "types": [ "bool" ], "variable": "$validate_nonce" }, { "name": "since", "content": "10.0.2" }, { "name": "return", "content": "" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_wc_review_badges", "file": "Features/TrustBadges.php", "type": "filter", "doc": { "description": "Filter WC review badges.", "long_description": "Allows external review sources (like reviewbird) to replace the badges.", "tags": [ { "name": "since", "content": "11.0.4" }, { "name": "param", "content": "Array of badge data arrays.", "types": [ "array" ], "variable": "$badges" }, { "name": "param", "content": "Review source setting (cart_only, cart_first, sitewide).", "types": [ "string" ], "variable": "$source" }, { "name": "param", "content": "Minimum star rating.", "types": [ "int" ], "variable": "$min_rating" }, { "name": "param", "content": "Maximum number of reviews.", "types": [ "int" ], "variable": "$limit" }, { "name": "param", "content": "Array of product IDs in cart.", "types": [ "array" ], "variable": "$cart_product_ids" } ], "long_description_html": "

Allows external review sources (like reviewbird) to replace the badges.

" }, "args": 5 }, { "name": "cfw_wcpay_payment_requests_ignore_shipping_phone", "file": "Compatibility/Gateways/WooCommercePayments.php", "type": "filter", "doc": { "description": "Filters whether to override Stripe payment request button heights", "long_description": "", "tags": [ { "name": "since", "content": "5.3.3" }, { "name": "param", "content": "Whether to ignore shipping phone requirement during payment requests", "types": [ "bool" ], "variable": "$allow" } ], "long_description_html": "" }, "args": 1 }, { "name": "checkoutwc_cart_shortcode_additional_classes", "file": "Features/SideCart.php", "type": "filter", "doc": { "description": "Filters additional classes for the cart icon shortcode", "long_description": "", "tags": [ { "name": "param", "content": "Additional classes for the cart icon shortcode", "types": [ "array" ], "variable": "$additional_classes" }, { "name": "since", "content": "8.2.18" } ], "long_description_html": "" }, "args": 1 }, { "name": "$hook_name", "file": "hook-wrapper-functions.php", "type": "filter", "doc": { "description": "Filter the value of a hook", "long_description": "", "tags": [ { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "'cfw_thank_you_status_icon_' . $order_status", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters thank you status icon class", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "Thank you status icon class", "types": [ "string" ], "variable": "$thank_you_status_icon" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_ab_test_url_parameter", "file": "ab-testing-api.php", "type": "filter", "doc": { "description": "Filters the URL parameter for loading AB tests by URL", "long_description": "", "tags": [ { "name": "since", "content": "8.2.8" }, { "name": "param", "content": "", "types": [ "string" ], "variable": "$url_parameter" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_account_creation_statement", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters create account statement", "long_description": "", "tags": [ { "name": "param", "content": "Create account statement", "types": [ "string" ], "variable": "$create_account_statement" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_acr_email_custom_css", "file": "functions.php", "type": "filter", "doc": { "description": "Filter the cart table custom styles", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "string" ], "variable": "$styles" }, { "name": "since", "content": "10.0.2" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_admin_pages", "file": "init.php", "type": "filter", "doc": { "description": "Filters the admin pages.", "long_description": "", "tags": [ { "name": "param", "content": "the admin pages", "types": [ "array" ], "variable": "$admin_pages" }, { "name": "since", "content": "10.1.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_admin_preview_message", "file": "init.php", "type": "filter", "doc": { "description": "Filter the admin preview message.", "long_description": "", "tags": [ { "name": "param", "content": "the admin preview message", "types": [ "string" ], "variable": "$admin_message" }, { "name": "return", "content": "the admin preview message" }, { "name": "since", "content": "10.1.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_already_have_account_text", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters already have account text", "long_description": "", "tags": [ { "name": "param", "content": "Already have an account text", "types": [ "string" ], "variable": "$already_have_account_text" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_available_shipping_methods", "file": "functions.php", "type": "filter", "doc": { "description": "Filter the available shipping methods displayed on checkout page", "long_description": "", "tags": [ { "name": "since", "content": "8.0.0" }, { "name": "param", "content": "The shipping package", "types": [ "array" ], "variable": "$package" }, { "name": "param", "content": "The package index", "types": [ "int" ], "variable": "$i" }, { "name": "param", "content": "The shipping rates", "types": [ "array" ], "variable": "$rates" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_billing_address_description", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters billing address description", "long_description": "", "tags": [ { "name": "param", "content": "Billing address description", "types": [ "string" ], "variable": "$billing_address_description" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_billing_address_different_address_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the label for the different billing address radio", "long_description": "", "tags": [ { "name": "param", "content": "The label for the different billing address radio", "types": [ "string" ], "variable": "$different_billing_address_label" }, { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_billing_address_same_as_shipping_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the label for the same as shipping address radio", "long_description": "", "tags": [ { "name": "param", "content": "The label for the same as shipping address radio", "types": [ "string" ], "variable": "$same_as_shipping_label" }, { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_billing_shipping_address_heading", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters billing and shipping address heading", "long_description": "", "tags": [ { "name": "param", "content": "Billing and shipping address heading", "types": [ "string" ], "variable": "$billing_and_shipping_address_heading" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_breadcrumb_cart_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filters breadcrumb cart link label", "long_description": "", "tags": [ { "name": "param", "content": "Breadcrumb cart link label", "types": [ "string" ], "variable": "$breadcrumb_cart_link_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_breadcrumb_cart_url", "file": "functions.php", "type": "filter", "doc": { "description": "Filters breadcrumb cart link URL", "long_description": "", "tags": [ { "name": "param", "content": "Breadcrumb cart link URL", "types": [ "string" ], "variable": "$breadcrumb_cart_link_url" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_breadcrumb_customer_info_label", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters the breadcrumb customer info label.", "long_description": "", "tags": [ { "name": "since", "content": "7.0.0" }, { "name": "param", "content": "the breadcrumb customer info label", "types": [ "string" ], "variable": "$label" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_breadcrumb_payment_label", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters the breadcrumb payment label.", "long_description": "", "tags": [ { "name": "since", "content": "7.0.0" }, { "name": "param", "content": "the breadcrumb payment label", "types": [ "string" ], "variable": "$label" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_breadcrumb_shipping_label", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters the breadcrumb shipping label.", "long_description": "", "tags": [ { "name": "since", "content": "7.0.0" }, { "name": "param", "content": "the breadcrumb shipping label", "types": [ "string" ], "variable": "$label" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_breadcrumbs", "file": "functions.php", "type": "filter", "doc": { "description": "Filters breadcrumbs", "long_description": "", "tags": [ { "name": "param", "content": "Breadcrumbs", "types": [ "string" ], "variable": "$breadcrumbs" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_cart_item_discount", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the discount HTML for a cart item", "long_description": "", "tags": [ { "name": "param", "content": "The discount HTML", "types": [ "string" ], "variable": "$discount_html" }, { "name": "param", "content": "The raw cart item", "types": [ "array" ], "variable": "$raw_item" }, { "name": "param", "content": "The product", "types": [ "\\WC_Product" ], "variable": "$product" }, { "name": "since", "content": "4.0.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_cart_item_quantity_max_value", "file": "functions.php", "type": "filter", "doc": { "description": "Filters cart item quantity control max value", "long_description": "", "tags": [ { "name": "param", "content": "The cart item key", "types": [ "string" ], "variable": "$cart_item_key" }, { "name": "param", "content": "The max value", "types": [ "int" ], "variable": "$max_value" }, { "name": "since", "content": "8.2.18" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_cart_item_quantity_min_value", "file": "functions.php", "type": "filter", "doc": { "description": "Filters cart item minimum quantity", "long_description": "", "tags": [ { "name": "param", "content": "The cart item", "types": [ "array" ], "variable": "$cart_item" }, { "name": "param", "content": "The cart item key", "types": [ "string" ], "variable": "$cart_item_key" }, { "name": "param", "content": "Cart item minimum quantity", "types": [ "int" ], "variable": "$min_quantity" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_cart_item_quantity_step", "file": "functions.php", "type": "filter", "doc": { "description": "Filters cart item quantity step", "long_description": "Determines how much to increment or decrement by", "tags": [ { "name": "param", "content": "The cart item", "types": [ "array" ], "variable": "$cart_item" }, { "name": "param", "content": "The cart item key", "types": [ "string" ], "variable": "$cart_item_key" }, { "name": "param", "content": "Cart item quantity step amount", "types": [ "int" ], "variable": "$quantity_step" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "

Determines how much to increment or decrement by

" }, "args": 3 }, { "name": "cfw_cart_quantity_input_has_override", "file": "functions.php", "type": "filter", "doc": { "description": "Filters whether the cart quantity input has been overridden", "long_description": "", "tags": [ { "name": "param", "content": "Whether the cart quantity input has been overridden", "types": [ "bool" ], "variable": "$has_override" }, { "name": "since", "content": "8.2.18" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_cart_totals_shipping_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filters cart totals shipping label", "long_description": "", "tags": [ { "name": "param", "content": "Cart totals shipping label", "types": [ "string" ], "variable": "$cart_totals_shipping_label" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_continue_to_order_review_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filter continue to order review button label", "long_description": "", "tags": [ { "name": "param", "content": "Continue to order review button label", "types": [ "string" ], "variable": "$continue_to_order_review_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_continue_to_payment_method_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filter continue to payment method button label", "long_description": "", "tags": [ { "name": "param", "content": "Continue to payment method button label", "types": [ "string" ], "variable": "$continue_to_payment_method_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_continue_to_shipping_method_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filter continue to shipping method button label", "long_description": "", "tags": [ { "name": "param", "content": "Continue to shipping method button label", "types": [ "string" ], "variable": "$continue_to_shipping_method_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_create_account_checkbox_label", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters create account checkbox label", "long_description": "", "tags": [ { "name": "param", "content": "Create account checkbox label", "types": [ "string" ], "variable": "$create_account_checkbox_label" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_create_account_site_name", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters create account checkbox site name", "long_description": "", "tags": [ { "name": "param", "content": "Create account checkbox site name", "types": [ "string" ], "variable": "$create_account_site_name" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_customer_information_heading", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters customer info tab heading", "long_description": "", "tags": [ { "name": "param", "content": "Customer info tab heading", "types": [ "string" ], "variable": "$customer_info_heading" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_default_billing_address_radio_selection", "file": "functions.php", "type": "filter", "doc": { "description": "Filters default billing address radio selection", "long_description": "", "tags": [ { "name": "param", "content": "Default billing address radio selection", "types": [ "string" ], "variable": "$default" }, { "name": "since", "content": "8.2.28" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_empty_side_cart_heading", "file": "template-functions.php", "type": "filter", "doc": { "description": "Fires before the empty cart message is output.", "long_description": "", "tags": [ { "name": "since", "content": "6.2.0" }, { "name": "param", "content": "the message", "types": [ "string" ], "variable": "$message" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_enable_side_cart_woocommerce_after_cart_totals_hook", "file": "functions.php", "type": "filter", "doc": { "description": "Whether to enable woocommerce_after_cart_totals hook for side cart", "long_description": "", "tags": [ { "name": "since", "content": "9.0.37" }, { "name": "param", "content": "Whether to enable woocommerce_after_cart_totals hook for side cart", "types": [ "bool" ], "variable": "$enable_side_cart_woocommerce_after_cart_totals_hook" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_ensure_selected_payment_method", "file": "functions.php", "type": "filter", "doc": { "description": "Filter whether to ensure a payment method is selected", "long_description": "", "tags": [ { "name": "param", "content": "Whether to ensure a payment method is selected", "types": [ "array" ], "variable": "$ensure_selected_payment_method" }, { "name": "since", "content": "8.2.11" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_express_pay_separator_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filters payment request button separator text", "long_description": "", "tags": [ { "name": "param", "content": "The separator label (default: Or)", "types": [ "string" ], "variable": "$separator_label" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_force_display_billing_address", "file": "functions.php", "type": "filter", "doc": { "description": "Filters whether to force displaying the billing address (no accordion)", "long_description": "", "tags": [ { "name": "param", "content": "Force displaying billing address", "types": [ "bool" ], "variable": "$force_display_billing_address" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_form_attributes", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters the form attributes", "long_description": "", "tags": [ { "name": "since", "content": "6.1.7" }, { "name": "param", "content": "The form attributes", "types": [ "array" ], "variable": "$attributes" }, { "name": "param", "content": "The form ID", "types": [ "string" ], "variable": "$id" }, { "name": "return", "content": "" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_gateway_order_button_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filters gateway order button text", "long_description": "", "tags": [ { "name": "param", "content": "The gateway order button text", "types": [ "string" ], "variable": "$gateway_order_button_text" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_get_account_checkout_fields", "file": "functions.php", "type": "filter", "doc": { "description": "Filters account address checkout fields", "long_description": "", "tags": [ { "name": "param", "content": "Account checkout fields", "types": [ "array" ], "variable": "$account_checkout_fields" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_billing_checkout_fields", "file": "functions.php", "type": "filter", "doc": { "description": "Filters billing address checkout fields", "long_description": "", "tags": [ { "name": "param", "content": "Billing address checkout fields", "types": [ "array" ], "variable": "$billing_checkout_fields" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_cart_actions_data", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the cart actions data", "long_description": "", "tags": [ { "name": "param", "content": "The cart actions data", "types": [ "array" ], "variable": "$data" }, { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_cart_static_actions_data", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the cart actions data", "long_description": "", "tags": [ { "name": "param", "content": "The cart actions data", "types": [ "array" ], "variable": "$data" }, { "name": "since", "content": "9.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_cart_totals_data", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the cart totals data", "long_description": "", "tags": [ { "name": "param", "content": "The cart totals data", "types": [ "array" ], "variable": "$data" }, { "name": "since", "content": "10.1.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_checkout_tabs", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters the checkout tabs", "long_description": "", "tags": [ { "name": "since", "content": "7.0.0" }, { "name": "param", "content": "The checkout tabs", "types": [ "array" ], "variable": "$tabs" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_gateway_icons", "file": "functions.php", "type": "filter", "doc": { "description": "Filters gateway order button text", "long_description": "", "tags": [ { "name": "param", "content": "The gateway icon HTML", "types": [ "string" ], "variable": "$icons" }, { "name": "param", "content": "", "types": [ "\\WC_Payment_Gateway" ], "variable": "$" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_get_logo_attachment_id", "file": "functions.php", "type": "filter", "doc": { "description": "Filters header logo attachment ID", "long_description": "", "tags": [ { "name": "param", "content": "The logo attachment ID", "types": [ "int" ], "variable": "$logo_attachment_id" }, { "name": "since", "content": "8.2.23" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_order_bumps", "file": "functions.php", "type": "filter", "doc": { "description": "Filter order bumps before processing", "long_description": "", "tags": [ { "name": "param", "content": "Array of bump objects", "types": [ "array" ], "variable": "$bumps" }, { "name": "since", "content": "11.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_order_bumps_data", "file": "functions.php", "type": "filter", "doc": { "description": "Filter order bumps data before returning", "long_description": "", "tags": [ { "name": "param", "content": "The order bumps data array", "types": [ "array" ], "variable": "$data" }, { "name": "since", "content": "11.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_review_pane_billing_address", "file": "functions.php", "type": "filter", "doc": { "description": "Filters review pane billing address", "long_description": "", "tags": [ { "name": "param", "content": "Review pane billing address", "types": [ "array" ], "variable": "$billing_details_address" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_get_review_pane_shipping_address", "file": "functions.php", "type": "filter", "doc": { "description": "Filters review pane formatted shipping address", "long_description": "", "tags": [ { "name": "param", "content": "Formatted shipping address", "types": [ "string" ], "variable": "$formatted_address" }, { "name": "since", "content": "7.3.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_shipping_checkout_fields", "file": "functions.php", "type": "filter", "doc": { "description": "Filters shipping address checkout fields", "long_description": "", "tags": [ { "name": "param", "content": "Shipping address checkout fields", "types": [ "array" ], "variable": "$shipping_checkout_fields" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_get_shipping_details_address", "file": "functions.php", "type": "filter", "doc": { "description": "Filters review pane shipping address", "long_description": "", "tags": [ { "name": "param", "content": "Review pane shipping address", "types": [ "array" ], "variable": "$shipping_details_address" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_get_suggested_products", "file": "functions.php", "type": "filter", "doc": { "description": "Filter suggested products", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "array" ], "variable": "$cross_sells" }, { "name": "param", "content": "", "types": [ "int" ], "variable": "$limit" }, { "name": "param", "content": "", "types": [ "bool" ], "variable": "$random_fallback" }, { "name": "return", "content": "The suggested products" }, { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_get_woocommerce_notices", "file": "functions.php", "type": "filter", "doc": { "description": "Filters WooCommerce notices before display", "long_description": "", "tags": [ { "name": "param", "content": "", "types": [ "array" ], "variable": "$all_notices" }, { "name": "since", "content": "8.2.23" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_header_blog_name", "file": "functions.php", "type": "filter", "doc": { "description": "Filters header logo / title link URL", "long_description": "", "tags": [ { "name": "param", "content": "The link URL", "types": [ "string" ], "variable": "$url" }, { "name": "since", "content": "5.3.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_header_home_url", "file": "functions.php", "type": "filter", "doc": { "description": "Filters header logo / title link URL", "long_description": "", "tags": [ { "name": "param", "content": "The link URL", "types": [ "string" ], "variable": "$url" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_hide_email_field_for_logged_in_users", "file": "template-functions.php", "type": "filter", "doc": { "description": "Shows the email field if the user is not logged in and the setting is enabled", "long_description": "", "tags": [ { "name": "param", "content": "Whether to show the email field", "types": [ "bool" ], "variable": "$show_email_field" }, { "name": "since", "content": "7.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_is_checkout", "file": "functions.php", "type": "filter", "doc": { "description": "Filter cfw_is_checkout()", "long_description": "", "tags": [ { "name": "param", "content": "Whether we are on the checkout page", "types": [ "bool" ], "variable": "$is_checkout" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_is_checkout_pay_page", "file": "functions.php", "type": "filter", "doc": { "description": "Filter is_checkout_pay_page()", "long_description": "", "tags": [ { "name": "param", "content": "Whether we are on the checkout pay page", "types": [ "bool" ], "variable": "$is_checkout_pay_page" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_is_order_received_page", "file": "functions.php", "type": "filter", "doc": { "description": "Filter is_order_received_page()", "long_description": "", "tags": [ { "name": "param", "content": "Whether we are on the order received page", "types": [ "bool" ], "variable": "$is_order_received_page" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_items_summary_table_html", "file": "functions.php", "type": "filter", "doc": { "description": "This filter is documented elsewhere in this file", "long_description": "", "tags": [], "long_description_html": "" }, "args": 2 }, { "name": "cfw_login_faster_text", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters login faster text", "long_description": "", "tags": [ { "name": "param", "content": "Login faster text", "types": [ "string" ], "variable": "$login_faster_text" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_login_form_account_does_not_exist_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the text before the login form for users who have shopped with us before", "long_description": "Default: If you have shopped with us before, please enter your login details below.", "tags": [ { "name": "since", "content": "9.0.34" }, { "name": "param", "content": "The text", "types": [ "string" ], "variable": "$text" } ], "long_description_html": "

Default: If you have shopped with us before, please enter your login details below.

" }, "args": 1 }, { "name": "cfw_login_form_account_exists_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the text for users who already have an account", "long_description": "Default: It looks like you already have an account. Please enter your login details below.", "tags": [ { "name": "since", "content": "9.0.34" }, { "name": "param", "content": "The text", "types": [ "string" ], "variable": "$text" } ], "long_description_html": "

Default: It looks like you already have an account. Please enter your login details below.

" }, "args": 1 }, { "name": "cfw_login_form_continue_as_guest_button_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the text for the continue as guest button", "long_description": "", "tags": [ { "name": "since", "content": "9.0.34" }, { "name": "param", "content": "The text", "types": [ "string" ], "variable": "$text" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_login_modal_last_password_link", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the link to the Lost Password page.", "long_description": "", "tags": [ { "name": "since", "content": "9.0.34" }, { "name": "param", "content": "the link to the Lost Password page", "types": [ "string" ], "variable": "$link" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_maybe_output_tracking_numbers", "file": "functions.php", "type": "filter", "doc": { "description": "Filter tracking numbers output on thank you page", "long_description": "", "tags": [ { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "The tracking numbers output HTML", "types": [ "string" ], "variable": "$tracking_numbers_output" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_no_payment_required_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filters no payment required text", "long_description": "", "tags": [ { "name": "param", "content": "No payment required text", "types": [ "string" ], "variable": "$no_payment_required_text" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_no_shipping_method_selected_message", "file": "functions.php", "type": "filter", "doc": { "description": "Filters shipping total text when no shipping methods are available", "long_description": "", "tags": [ { "name": "param", "content": "Shipping total text when no shipping methods are available", "types": [ "string" ], "variable": "$new_shipping_total_not_available_text" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_order_review_tab_heading", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters order review tab heading", "long_description": "", "tags": [ { "name": "param", "content": "Order review tab heading", "types": [ "string" ], "variable": "$order_review_tab_heading" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_order_totals_html", "file": "functions.php", "type": "filter", "doc": { "description": "Filters order totals HTML", "long_description": "", "tags": [ { "name": "param", "content": "Cart totals HTML", "types": [ "string" ], "variable": "$order_totals_html" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_order_updates_text", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters order updates text", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "Thank you page order updates text", "types": [ "string" ], "variable": "$order_updates_text" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_payment_gateway_field_html_{$gateway->id}", "file": "functions.php", "type": "filter", "doc": { "description": "Filters gateway payment field output HTML", "long_description": "", "tags": [ { "name": "param", "content": "Payment gateway output HTML", "types": [ "string" ], "variable": "$gateway_output" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_payment_gateway_{$gateway->id}_content", "file": "functions.php", "type": "filter", "doc": { "description": "Filters whether to show gateway content", "long_description": "", "tags": [ { "name": "param", "content": "Show gateway content", "types": [ "bool" ], "variable": "$show" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_payment_method_address_review_shipping_method", "file": "functions.php", "type": "filter", "doc": { "description": "Filters chosen shipping methods label", "long_description": "", "tags": [ { "name": "param", "content": "The chosen shipping methods", "types": [ "string" ], "variable": "$chosen_shipping_methods_labels" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_payment_method_heading", "file": "functions.php", "type": "filter", "doc": { "description": "Filters payment methods heading", "long_description": "", "tags": [ { "name": "param", "content": "Payment methods heading", "types": [ "string" ], "variable": "$payment_methods_heading" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_payment_method_li_class", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the class attribute of the payment method list item.", "long_description": "", "tags": [ { "name": "param", "content": "the payment gateway object", "types": [ "\\WC_Payment_Gateway" ], "variable": "$gateway" }, { "name": "param", "content": "the payment method list item class attribute", "types": [ "string" ], "variable": "$li_class_attribute" }, { "name": "since", "content": "2.0.0" }, { "name": "since", "content": "10.1.0", "description": "Added $gateway argument." } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_place_order_button_container_classes", "file": "functions.php", "type": "filter", "doc": { "description": "Filters place order button container classes", "long_description": "", "tags": [ { "name": "param", "content": "Place order button container classes", "types": [ "array" ], "variable": "$place_order_button_container_classes" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_pre_output_fieldset_field_args", "file": "functions.php", "type": "filter", "doc": { "description": "Filters fieldset field args", "long_description": "", "tags": [ { "name": "param", "content": "Field args", "types": [ "array" ], "variable": "$field" }, { "name": "param", "content": "Field key", "types": [ "string" ], "variable": "$key" }, { "name": "since", "content": "7.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_replace_form", "file": "futurist/content.php", "type": "filter", "doc": { "description": "Filters whether to use the standard CheckoutWC form or allow it to be overridden", "long_description": "", "tags": [ { "name": "since", "content": "2.0.0" }, { "name": "param", "content": "Whether to replace the form or use the standard one", "types": [ "bool" ], "variable": "$replace" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_return_to_cart_link", "file": "functions.php", "type": "filter", "doc": { "description": "Filter return to cart link", "long_description": "", "tags": [ { "name": "param", "content": "Return to cart link", "types": [ "string" ], "variable": "$cart_link" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_return_to_cart_link_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filter return to cart link text", "long_description": "", "tags": [ { "name": "param", "content": "Return to cart link text", "types": [ "string" ], "variable": "$return_to_cart_link_text" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_return_to_cart_link_url", "file": "functions.php", "type": "filter", "doc": { "description": "Filter return to cart link URL", "long_description": "", "tags": [ { "name": "param", "content": "Return to cart link URL", "types": [ "string" ], "variable": "$return_to_cart_link_url" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_return_to_customer_info_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filter return to customer information tab label", "long_description": "", "tags": [ { "name": "param", "content": "Return to customer information tab label", "types": [ "string" ], "variable": "$return_to_customer_info_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_return_to_customer_information_link", "file": "functions.php", "type": "filter", "doc": { "description": "Filter return to customer information tab link", "long_description": "", "tags": [ { "name": "param", "content": "Return to customer information tab link", "types": [ "string" ], "variable": "$return_to_customer_info_link" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_return_to_payment_method_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filter return to payment method tab label", "long_description": "", "tags": [ { "name": "param", "content": "Return to payment method tab label", "types": [ "string" ], "variable": "$return_to_payment_method_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_return_to_payment_method_link", "file": "functions.php", "type": "filter", "doc": { "description": "Filter return to payment method tab link", "long_description": "", "tags": [ { "name": "param", "content": "Return to payment method tab link", "types": [ "string" ], "variable": "$return_to_payment_method_link" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_return_to_shipping_method_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filter return to shipping method tab label", "long_description": "", "tags": [ { "name": "param", "content": "Return to shipping method tab label", "types": [ "string" ], "variable": "$return_to_shipping_method_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_return_to_shipping_method_link", "file": "functions.php", "type": "filter", "doc": { "description": "Filter return to shipping method tab link", "long_description": "", "tags": [ { "name": "param", "content": "Return to shipping method tab link", "types": [ "string" ], "variable": "$return_to_shipping_method_link" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_review_pane_contact_value", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the contact value for the review pane", "long_description": "", "tags": [ { "name": "param", "content": "The contact value", "types": [ "string" ], "variable": "$content" }, { "name": "since", "content": "7.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_review_pane_show_shipping_method", "file": "functions.php", "type": "filter", "doc": { "description": "Filters whether to show the shipping method tab in the review pane.", "long_description": "", "tags": [ { "name": "since", "content": "9.0.33" }, { "name": "param", "content": "whether to show the shipping method tab in the review pane", "types": [ "bool" ], "variable": "$show" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_ship_to_label", "file": "functions.php", "type": "filter", "doc": { "description": "Filters ship to label in review pane", "long_description": "", "tags": [ { "name": "param", "content": "Ship to label", "types": [ "string" ], "variable": "$ship_to_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_shipping_address_heading", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters shipping address heading", "long_description": "", "tags": [ { "name": "param", "content": "Shipping address heading", "types": [ "string" ], "variable": "$shipping_address_heading" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_shipping_free_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the text displayed when free shipping is available.", "long_description": "", "tags": [ { "name": "since", "content": "5.0.0" }, { "name": "param", "content": "the text to display", "types": [ "string" ], "variable": "$text" }, { "name": "return", "content": "" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_shipping_total_address_required_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filters shipping total address required text", "long_description": "", "tags": [ { "name": "param", "content": "Shipping total address required text", "types": [ "string" ], "variable": "$address_required_text" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_shipping_total_not_available_text", "file": "functions.php", "type": "filter", "doc": { "description": "Filters shipping total text when no shipping methods are available", "long_description": "", "tags": [ { "name": "param", "content": "Shipping total text when no shipping methods are available", "types": [ "string" ], "variable": "$new_shipping_total_not_available_text" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_customer_information_tab", "file": "functions.php", "type": "filter", "doc": { "description": "Filters whether to show customer information tab", "long_description": "", "tags": [ { "name": "param", "content": "Show customer information tab", "types": [ "bool" ], "variable": "$show_customer_information_tab" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_gateway_{$gateway->id}", "file": "functions.php", "type": "filter", "doc": { "description": "Filters whether to show gateway in list of gateways", "long_description": "", "tags": [ { "name": "param", "content": "Show gateway output", "types": [ "bool" ], "variable": "$show" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_logout_link", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters whether to show logout link", "long_description": "", "tags": [ { "name": "param", "content": "Show logout link", "types": [ "bool" ], "variable": "$show_logout_link" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_order_summary_hide_link_text", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters hide order summary link label", "long_description": "", "tags": [ { "name": "param", "content": "The hide order summary label", "types": [ "string" ], "variable": "$hide_order_summary_label" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_order_summary_link_text", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters show order summary link label", "long_description": "", "tags": [ { "name": "param", "content": "The show order summary link label", "types": [ "string" ], "variable": "$show_order_summary_label" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_return_to_cart_link", "file": "functions.php", "type": "filter", "doc": { "description": "Filters whether to show the return to cart link", "long_description": "", "tags": [ { "name": "since", "content": "6.0.0" }, { "name": "param", "content": "Whether to show the return to cart link", "types": [ "bool" ], "variable": "$show" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_review_order_before_cart_contents_hook", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters whether woocommerce_review_order_before_cart_contents hook is allowed to output", "long_description": "", "tags": [ { "name": "param", "content": "Whether to output hook", "types": [ "bool" ], "variable": "$show_hook" }, { "name": "since", "content": "4.3.2" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_shipping_tab", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters whether to show shipping tab", "long_description": "", "tags": [ { "name": "param", "content": "Show shipping tab", "types": [ "string" ], "variable": "$show_shipping_tab" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_show_shipping_total", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters whether to show shipping total", "long_description": "", "tags": [ { "name": "param", "content": "Show shipping total", "types": [ "string" ], "variable": "$show_shipping_total" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_template_cart_el", "file": "functions.php", "type": "filter", "doc": { "description": "Filters order totals element ID", "long_description": "", "tags": [ { "name": "param", "content": "Order totals element ID", "types": [ "string" ], "variable": "$order_totals_list_element_id" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_template_redirect_priority", "file": "functions.php", "type": "filter", "doc": { "description": "Filters CheckoutWC template redirect priority", "long_description": "", "tags": [ { "name": "param", "content": "The priority of the template_redirect action", "types": [ "int" ], "variable": "$priority" }, { "name": "return", "content": "" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_continue_shopping_text", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters thank you page continue shopping button text", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "Thank you page continue shopping button text", "types": [ "string" ], "variable": "$cfw_thank_you_continue_shopping_text" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_heading_icon", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters thank you page heading icon", "long_description": "", "tags": [ { "name": "param", "content": "Thank you page heading icon output", "types": [ "string" ], "variable": "$cfw_thank_you_heading_icon" }, { "name": "since", "content": "5.4.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_thank_you_shipment_tracking_header", "file": "functions.php", "type": "filter", "doc": { "description": "Filters tracking link header on thank you page", "long_description": "", "tags": [ { "name": "param", "content": "Tracking link header", "types": [ "string" ], "variable": "$shipment_tracking_header" }, { "name": "param", "content": "The shipping provider for tracking link", "types": [ "string" ], "variable": "$tracking_provider" }, { "name": "since", "content": "3.14.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_thank_you_shipment_tracking_link", "file": "functions.php", "type": "filter", "doc": { "description": "Filters tracking link output on thank you page", "long_description": "", "tags": [ { "name": "param", "content": "Tracking link output", "types": [ "string" ], "variable": "$shipment_tracking_link" }, { "name": "param", "content": "The tracking link", "types": [ "string" ], "variable": "$tracking_link" }, { "name": "param", "content": "The tracking number", "types": [ "string" ], "variable": "$tracking_number" }, { "name": "since", "content": "3.14.0" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_thank_you_subtitle", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters thank you page heading subtitle", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "Thank you page heading subtitle", "types": [ "string" ], "variable": "$thank_you_subtitle" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_title", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters thank you page heading title", "long_description": "", "tags": [ { "name": "since", "content": "3.0.0" }, { "name": "param", "content": "Thank you page heading title", "types": [ "string" ], "variable": "$thank_you_title" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_thank_you_tracking_numbers", "file": "functions.php", "type": "filter", "doc": { "description": "Filter to handle custom shipment tracking links output on thank you page", "long_description": "", "tags": [ { "name": "param", "content": "The order object", "types": [ "\\WC_Order" ], "variable": "$order" }, { "name": "param", "content": "The tracking numbers output", "types": [ "string" ], "variable": "$custom_tracking_numbers_output" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_totals_itemize_shipping_costs", "file": "functions.php", "type": "filter", "doc": { "description": "Whether to itemize shipping costs", "long_description": "", "tags": [ { "name": "since", "content": "10.1.7" }, { "name": "param", "content": "Whether to itemize shipping costs in totals (default: false)", "types": [ "array" ], "variable": "$itemize_shipping_costs" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_transactions_encrypted_statement", "file": "functions.php", "type": "filter", "doc": { "description": "Filters payment methods transactions are encrypted statement", "long_description": "", "tags": [ { "name": "param", "content": "Payment methods transactions are encrypted statement", "types": [ "string" ], "variable": "$transactions_encrypted_statement" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_trust_badges", "file": "functions.php", "type": "filter", "doc": { "description": "Filter to add additional trust badges (like WooCommerce reviews)", "long_description": "", "tags": [ { "name": "since", "content": "10.2.9" }, { "name": "param", "content": "Existing trust badges", "types": [ "array" ], "variable": "$badges" }, { "name": "param", "content": "Whether to apply rules", "types": [ "bool" ], "variable": "$apply_rules" } ], "long_description_html": "" }, "args": 2 }, { "name": "cfw_unique_billing_fields", "file": "functions.php", "type": "filter", "doc": { "description": "Filters the unique billing fields.", "long_description": "", "tags": [ { "name": "since", "content": "7.2.1" }, { "name": "param", "content": "the unique billing fields", "types": [ "array" ], "variable": "$unique_fields" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_wc_print_notices", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters WooCommerce notices before display", "long_description": "", "tags": [ { "name": "since", "content": "8.2.19" }, { "name": "param", "content": "", "types": [ "array" ], "variable": "$all_notices" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_welcome_back_email", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters welcome back statement customer email", "long_description": "", "tags": [ { "name": "param", "content": "Welcome back statement customer email", "types": [ "string" ], "variable": "$welcome_back_email" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_welcome_back_name", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters welcome back statement customer name", "long_description": "", "tags": [ { "name": "param", "content": "Welcome back statement customer name", "types": [ "string" ], "variable": "$welcome_back_name" }, { "name": "since", "content": "2.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_welcome_back_text", "file": "template-functions.php", "type": "filter", "doc": { "description": "Filters welcome back statement", "long_description": "", "tags": [ { "name": "param", "content": "Welcome back statement", "types": [ "string" ], "variable": "$welcome_back_text" }, { "name": "since", "content": "7.1.10" } ], "long_description_html": "" }, "args": 3 }, { "name": "cfw_{$context}_main_container_classes", "file": "functions.php", "type": "filter", "doc": { "description": "Filters main container classes", "long_description": "", "tags": [ { "name": "param", "content": "Main container classes", "types": [ "string" ], "variable": "$classes" }, { "name": "since", "content": "3.0.0" } ], "long_description_html": "" }, "args": 1 }, { "name": "cfw_groove_cart_summary_classes", "file": "groove/thank-you.php", "type": "filter", "doc": { "description": "Filters the classes for the cart summary", "long_description": "", "tags": [ { "name": "param", "content": "The classes for the cart summary", "types": [ "array" ], "variable": "$cart_summary_classes" }, { "name": "since", "content": "8.0.0" } ], "long_description_html": "" }, "args": 1 } ] }