Gravity Wiz Gravity Wiz
GF eCommerce Fields

gpecf_order_summary

  1. Description
  2. Usage
  3. Examples
    1. Consolidate Discounts
    2. Add Custom Total
  4. Since

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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<?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