gfpdf_password

The Gravity PDF gfpdf password hook.

Description

apply_filters( 'gfpdf_password', (unknown) $settings_password, (unknown) $form, (unknown) $entry ); 

Parameters (3)

0. $settings_password (unknown)
The settings password.
1. $form (unknown)
The form.
2. $entry (unknown)
The entry.

Usage

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

Defined (1)

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

/src/model/Model_PDF.php  
  1. $settings['password'] = apply_filters( 'gfpdf_password', $settings['password'], $form, $entry );