Set Discount Amount by Field Value

Instructions

See “Where do I put snippets?” in our documentation for installation instructions.

Code

Filename: gpecf-set-discount-amount-by-field-value.php

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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?php
/**
 * Gravity Perks // GP eCommerce Fields // Set Discount Amount by Field Value
 * https://gravitywiz.com/documentation/gravity-forms-ecommerce-fields/
 */
class GPECF_Discount_Amounts_By_Field_Value {

	private $_args = array();

	public function __construct( $args = array() ) {

		// set our default arguments, parse against the provided arguments, and store for use throughout the class
		$this->_args = wp_parse_args( $args, array(
			'form_id'           => false,
			'discount_field_id' => false,
			'amount_field_id'   => false,
		) );

		// do version check in the init to make sure if GF is going to be loaded, it is already loaded
		add_action( 'init', array( $this, 'init' ) );

	}

	public function init() {

		add_filter( 'gform_pre_render', array( $this, 'load_form_script' ), 10, 2 );
		add_filter( 'gform_register_init_scripts', array( $this, 'add_init_script' ), 10, 2 );

		add_filter( 'gform_pre_process', array( $this, 'set_discount_amount_by_field_value' ) );
		add_action( 'gform_product_info', array( $this, 'set_discount_amount_for_order' ), 8, 3 );

	}

	public function set_discount_amount_by_field_value( $form ) {

		if ( ! $this->is_applicable_form( $form ) ) {
			return $form;
		}

		foreach ( $form['fields'] as &$field ) {
			if ( $field->id == $this->_args['discount_field_id'] ) {
				$field->discountAmount = rgpost( 'input_' . $this->_args['amount_field_id'] );
			}
		}

		return $form;
	}

	public function set_discount_amount_for_order( $order, $form, $entry ) {

		if ( ! $this->is_applicable_form( $form ) ) {
			return $order;
		}

		$discount_field = GFAPI::get_field( $form, $this->_args['discount_field_id'] );
		$value          = rgar( $entry, $this->_args['amount_field_id'] );

		if ( strpos( $value, '|' ) !== false ) {
			$value = explode( '|', $value )[0];
		}

		$discount_field->discountAmount = $value;

		return $order;
	}

	public function load_form_script( $form, $is_ajax_enabled ) {

		if ( $this->is_applicable_form( $form ) && ! has_action( 'wp_footer', array( $this, 'output_script' ) ) ) {
			add_action( 'wp_footer', array( $this, 'output_script' ) );
			add_action( 'gform_preview_footer', array( $this, 'output_script' ) );
		}

		return $form;
	}

	public function output_script() {
		?>

		<script type="text/javascript">

			( function( $ ) {

				window.GPECFSetDiscountByFieldValue = function( args ) {

					var self = this;

					// copy all args to current object: (list expected props)
					for( var prop in args ) {
						if( args.hasOwnProperty( prop ) ) {
							self[ prop ] = args[ prop ];
						}
					}

					self.init = function() {

						var $amountInput = self.$getInput( self.amountFieldId );

						$( '#gform_' + self.formId ).on( 'change', '#' + $amountInput.attr( 'id' ), function() {
							self.setDiscountAmount( $( this ).val() );
						} );

						self.setDiscountAmount( $amountInput.val() );

					};

					self.setDiscountAmount = function( value ) {
						// Clean the value to remove the thousand separator (could be , or . depending on currency settings).
						if ( gform.Currency && typeof gform.Currency.cleanNumber === 'function' ) {
							// Gravity Forms 2.9 deprecates gformCleanNumber in favor of gform.Currency.cleanNumber.
							value = gform.Currency.cleanNumber( value, '', '', window.gf_global.gf_currency_config.decimal_separator ).toString();
						} else {
							// For Gravity Forms prior to 2.9.
							value = gformCleanNumber( value, '', '', window.gf_global.gf_currency_config.decimal_separator ).toString();
						}

						if ( value.indexOf( '|' ) !== -1 ) {
							value = value.split( '|' )[0];
						}

						self.$getInput( self.discountFieldId )
							.data( 'amount', value )
							.val( value )
							.trigger('change');

						window.gformCalculateTotalPrice(self.formId);

						// Trigger recalculations for formulas
						$( document ).trigger( 'gform_pre_conditional_logic', [ self.formId] );
					}

					self.$getInput = function( fieldId ) {
						return $( '#input_' + self.formId + '_' + fieldId );
					};

					self.init();

				}

			} )( jQuery );

		</script>

		<?php
	}

	public function add_init_script( $form ) {

		if ( ! $this->is_applicable_form( $form ) ) {
			return;
		}

		$args = array(
			'formId'          => $this->_args['form_id'],
			'discountFieldId' => $this->_args['discount_field_id'],
			'amountFieldId'   => $this->_args['amount_field_id'],
		);

		$script = 'new GPECFSetDiscountByFieldValue( ' . json_encode( $args ) . ' );';
		$slug   = implode( '_', array( 'gpecf_set_discount_by_field_value', $this->_args['form_id'], $this->_args['discount_field_id'], $this->_args['amount_field_id'] ) );

		GFFormDisplay::add_init_script( $this->_args['form_id'], $slug, GFFormDisplay::ON_PAGE_RENDER, $script );

	}

	public function is_applicable_form( $form ) {

		$form_id = isset( $form['id'] ) ? $form['id'] : $form;

		return empty( $this->_args['form_id'] ) || (int) $form_id == (int) $this->_args['form_id'];
	}

}

# Configuration

new GPECF_Discount_Amounts_By_Field_Value( array(
	'form_id'           => 123,
	'discount_field_id' => 4,
	'amount_field_id'   => 5,
) );

Comments

  1. Herb Hanson
    Herb Hanson January 9, 2025 at 3:51 pm

    Hi, I’m trying to use this snippet, but I am receiving the following error: Uncaught TypeError: value.indexOf is not a function

    I seem to have the form and field IDs correct, but I’m getting this error and the discount does not adjust based on the number in the number field.

    Reply
    1. Samuel Bassah
      Samuel Bassah Staff January 10, 2025 at 6:29 am

      Hi Herb,

      The issue appears to be with the snippet. I’ve forwarded this issue to our developers to look into it. We’ll update this comment when the issue is resolved.

      Best

Leave a Reply

Your email address will not be published. Required fields are marked *

  • Trouble installing this snippet? See our troubleshooting tips.
  • Need to include code? Create a gist and link to it in your comment.
  • Reporting a bug? Provide a URL where this issue can be recreated.

By commenting, I understand that I may receive emails related to Gravity Wiz and can unsubscribe at any time.