gform_display_product_summary

The Gravity Forms gform display product summary hook.

Description

apply_filters( 'gform_display_product_summary', (bool) $true, (unknown) $field, (unknown) $form, (unknown) $lead ); 

Parameters (4)

0. $true (bool)
The true.
1. $field (unknown)
The field.
2. $form (unknown)
The form.
3. $lead (unknown)
The lead.

Usage

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

Defined (2)

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

/common.php  
  1. $display_product_summary = apply_filters( 'gform_display_product_summary', true, $field, $form, $lead ); 
  1. $display_product_summary = apply_filters( 'gform_display_product_summary', true, $field, $form, $entry );