gform_currency_pre_save_entry_<form_id>

Allow the currency code to be overridden.

Description

apply_filters( 'gform_currency_pre_save_entry_<form_id>', $gfcommon, $form ); 

Parameters (2)

0. $gfcommon
The three character ISO currency code to be stored in the entry. Default is value returned by GFCommon::get_currency()
1. $form
The form currently being processed.

Usage

To run the hook, copy the example below.
  1. $gfcommon = apply_filters( 'gform_currency_pre_save_entry_{$form_id}', $gfcommon, $form ); 
  2.  
  3. if ( !empty( $gfcommon ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the gform_currency_pre_save_entry_<form_id> callback 
  2. function filter_gform_currency_pre_save_entry_form_id( $gfcommon, $form ) { 
  3. // make filter magic happen here... 
  4. return $gfcommon
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "gform_currency_pre_save_entry_{$form_id}", 'filter_gform_currency_pre_save_entry_form_id', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "gform_currency_pre_save_entry_{$form_id}", 'filter_gform_currency_pre_save_entry_form_id', 10, 2 ); 

Defined (2)

The filter is defined in the following location(s).

/forms_model.php  
  1. $currency = gf_apply_filters( array( 'gform_currency_pre_save_entry', $form['id'] ), GFCommon::get_currency(), $form ); 
  1. $lead['currency'] = gf_apply_filters( array( 'gform_currency_pre_save_entry', $form['id'] ), GFCommon::get_currency(), $form );