• Home
  • Pricing
  • Free Resources
  • About
  • Docs
  • Support
  • Account

Gravity Wiz

Magically enhanced tutorials, snippets and plugins for Gravity Forms!

  • Gravity Perks
    • Gravity Perks
    • Pricing
  • Blog
    • Free Resources
    • About
  • Support
    • Docs
    • Support
    • Account

gpecf_field_total (PHP)

  1. Description
  2. Usage
  3. Parameters
  4. Since
  5. Examples
    1. Add a Flat Rate of 5.5 to the Tax field with ID 4.

Description

Modify the calculation of the field total on submission.

This filter must be used with its JS counterpart to handle filtering the discount amount on the frontend.

Usage

Apply to all applicable fields on all forms.

add_filter( 'gpecf_field_total', 'my_custom_function' );

Apply to all applicable fields on a specific form.

add_filter( 'gpecf_field_total_FORMID', 'my_custom_function' );

Apply to a specific field on a specific form.

add_filter( 'gpecf_field_total_FORMID_FIELDID', 'my_custom_function' );

Parameters

  • field_total float

    The total for the current field.

  • args array

    The following properties are passed in the $args array.

    • amount float

    The amount of the current eCommerce field.

    • amountType string

      The type of amount.

    • products array

      The eCommerce field product.

    • productsType string

      The type of product.

    • includeShipping bool

      Whether to include shipping to the field total.

    • includeDiscounts bool

      Whether to include discount to the field total.

    • calculateByProduct bool

      Whether to calcululate by product.

    • field_id int

      The field ID of the current eCommerce field.

  • order array

    The order data.

  • entry array

    The current entry object.

  • total float

    The total for the current order.

Since

This filter is available since GP eCommerce Fields 1.2.18.

Examples

Add a Flat Rate of 5.5 to the Tax field with ID 4.

add_filter('gpecf_field_total_123_4', function( $field_total, $args, $order, $entry, $total ){

    return $field_total + 5.5;

},10,5);

All Perks

  • GF Address Autocomplete
  • GF Advanced Calculations
  • GF Advanced Phone Field
  • GF Advanced Save & Continue
  • GF Auto List Field
  • GF Auto Login
  • GF Better User Activation
  • GF Blocklist
  • 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 Entry Blocks
  • GF Expand Textareas
  • GF File Renamer
  • GF File Upload Pro
  • GF Google Sheets
  • GF Inventory
  • GF Limit Checkboxes
  • GF Limit Choices
  • 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 PayPal One-time Fee
  • GF Placeholder
  • 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 Terms Of Service
  • GF Unique ID
  • GF Word Count

Copyright © 2023 · Powered by WordPress · Gravity Wiz LLC

  • Support
  • Affiliates
  • About
  • Sitemap
  • Terms & Conditions of Use
  • Privacy Policy
  • Cookies Policy