gfpdf_template_args

Pre-process our template arguments and automatically render them in PDF.

Description

apply_filters( 'gfpdf_template_args', (unknown) $form_id_form_id, (string) $lead_ids_legacy_ids, (string) $lead_id_apply_filters_gfpdfe_lead_id_entry_id_form_entry_gfpdf, (string) $form_form, (string) $entry_entry, (string) $lead_entry, (string) $form_data_form_data, (string) $fields_fields, (string) $config_config, (string) $settings_settings, (string) $gfpdf_gfpdf, (unknown) $var, (unknown) $entry, (unknown) $settings, (unknown) $form ); 

Parameters (15)

0. $form_id_form_id — Optional. (unknown) => ['form_id' => $form['id']
The form id form id.
1. $lead_ids_legacy_ids — Optional. (string) => 'lead_ids' => $legacy_ids
The lead ids legacy ids.
2. $lead_id_apply_filters_gfpdfe_lead_id_entry_id_form_entry_gfpdf — Optional. (string) => 'lead_id' => apply_filters( 'gfpdfe_lead_id', $entry['id'], $form, $entry, $gfpdf )
The lead id apply filters gfpdfe lead id entry id form entry gfpdf.
3. $form_form — Optional. (string) => 'form' => $form
The form form.
4. $entry_entry — Optional. (string) => 'entry' => $entry
The entry entry.
5. $lead_entry — Optional. (string) => 'lead' => $entry
The lead entry.
6. $form_data_form_data — Optional. (string) => 'form_data' => $form_data
The form data form data.
7. $fields_fields — Optional. (string) => 'fields' => $fields
The fields fields.
8. $config_config — Optional. (string) => 'config' => $config
The config config.
9. $settings_settings — Optional. (string) => 'settings' => $settings
The settings settings.
10. $gfpdf_gfpdf — Optional. (string) => 'gfpdf' => $gfpdf
The gfpdf gfpdf.
11. $var (unknown) => ]
The var.
12. $entry (unknown)
The entry.
13. $settings (unknown)
The settings.
14. $form (unknown)
The form.

Usage

To run the hook, copy the example below.
  1. $form_id_form_id = apply_filters( 'gfpdf_template_args', $form_id_form_id, $lead_ids_legacy_ids, $lead_id_apply_filters_gfpdfe_lead_id_entry_id_form_entry_gfpdf, $form_form, $entry_entry, $lead_entry, $form_data_form_data, $fields_fields, $config_config, $settings_settings, $gfpdf_gfpdf, $var, $entry, $settings, $form ); 
  2.  
  3. if ( !empty( $form_id_form_id ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the gfpdf_template_args callback 
  2. function filter_gfpdf_template_args( $form_id_form_id, $lead_ids_legacy_ids, $lead_id_apply_filters_gfpdfe_lead_id_entry_id_form_entry_gfpdf, $form_form, $entry_entry, $lead_entry, $form_data_form_data, $fields_fields, $config_config, $settings_settings, $gfpdf_gfpdf, $var, $entry, $settings, $form ) { 
  3. // make filter magic happen here... 
  4. return $form_id_form_id
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'gfpdf_template_args', 'filter_gfpdf_template_args', 10, 15 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'gfpdf_template_args', 'filter_gfpdf_template_args', 10, 15 ); 

Defined (1)

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

/src/helper/Helper_Templates.php  
  1. return apply_filters( 'gfpdf_template_args', [