gpecf_order_summary
Description
Filter the order summary.
Usage
Apply to all forms.
add_filter( 'gpecf_order_summary', 'my_custom_function' );
Apply to a specific form.
add_filter( 'gpecf_order_summary_FORMID', 'my_custom_function' );
## Parameters
– **order_summary** [array]()
An array of order item groups (subtotal, discounts, coupons, shipping, taxes, total).
– **form** [array]()
The current form object.
– **entry** [array]()
The current entry object.
Examples
Consolidate Discounts
In this example, discounts are consolidated to a single line item in the Order Summary.
<?php
/**
* Gravity Perks // eCommerce Fields // Consolidate Separate Discount Line Items into a Single Discounts Line Item
* https://gravitywiz.com/documentation/gravity-forms-ecommerce-fields/
*
* Instruction Video: https://www.loom.com/share/8c00449041864d30833d334274947484
*
* Default: https://gwiz.io/2IiPALf
* w/ Snippet: https://gwiz.io/2Itfyfo
*/
// Update "123" to your form ID - or - remove "_123" to apply to all forms.
add_filter( 'gpecf_order_summary_123', function( $summary ) {
if ( empty( $summary['discounts'] ) ) {
return $summary;
}
$consolidated_discount = $summary['discounts'][0];
$consolidated_discount['name'] = 'Discounts';
$consolidated_discount['price'] = 0;
foreach ( $summary['discounts'] as $discount ) {
$consolidated_discount['price'] += $discount['price'];
}
$summary['discounts'] = array( $consolidated_discount );
return $summary;
} );
Add Custom Total
In this example, we add a custom total to the Order Summary.
<?php
/**
* Gravity Perks // GP eCommerce Fields // Add Custom Total to Order Summary
* https://gravitywiz.com/documentation/gravity-forms-ecommerce-fields/
*/
// Update "123" with your form ID.
add_filter( 'gpecf_order_summary_123', function( $order_summary ) {
$order_summary['total'] = array_merge( array(
array(
'name' => 'Recurring Total',
'price' => '$400',
'quantity' => 1,
'class' => 'total',
),
), $order_summary['total'] );
return $order_summary;
} );
Since
This filter is available since Gravity Forms eCommerce Fields 1.0.15.
All Connections
All Perks
- GF Address Autocomplete
- GF Advanced Calculations
- GF Advanced Phone Field
- GF Advanced Save & Continue
- GF Advanced Select
- GF Auto List Field
- GF Auto Login
- GF Better User Activation
- GF Blocklist
- GF Bookings
- GF Conditional Logic Dates
- GF Conditional Pricing
- GF Copy Cat
- GF Date Time Calculator
- GF Disable Entry Creation
- GF Easy Passthrough
- GF eCommerce Fields
- GF Email Users
- GF Email Validator
- GF Entry Blocks
- GF Expand Textareas
- GF File Renamer
- GF File Upload Pro
- GF Inventory
- GF Limit Checkboxes
- GF Limit Dates
- GF Limit Submissions
- GF Live Preview
- GF Media Library
- GF Multi-Page Navigation
- GF Nested Forms
- GF Notification Scheduler
- GF Page Transitions
- GF Pay Per Word
- GF Populate Anything
- GF Post Content Merge Tags
- GF Preview Submission
- GF Price Range
- GF QR Code
- GF Randomizer
- GF Read Only
- GF Reload Form
- GF Submit to Access
- GF Terms Of Service
- GF Unique ID
- GF Word Count