Version: v5

gfpdf_get_active_pdfs

Description

This filter can be used to programmatically enable or disable a PDF configured on the form. By default, Gravity PDF will check if the PDF status is active and the conditional logic is valid. This hook allows you to filter PDFs with advanced logic.

Version

This filter was introduced in Gravity PDF 4.2.

Parameters

$filtered | array

  • The filtered list of PDF settings

$pdfs | array

  • The unfiltered list of PDF settings

$entry | array

  • The raw Gravity Form Entry array.

$form | array

  • The Gravity Forms array

Usage

Use the following code to enable the form's PDFs if two sets of conditions are true (something you cannot do with standard Gravity Forms conditional logic), otherwise disable the documents:

add_filter( 'gfpdf_get_active_pdfs', function( $filtered, $pdfs, $entry, $form ) {
if( $form['id'] == 5 ) {
if ( ( $entry[1] === 'Australia' || $entry[1] === 'New Zealand' ) && $entry[2] === 'Married' ) {
return $filtered;
} else {
return [];
}
}
return $filtered;
}, 10, 4 );

If you'd like to disable a PDF if a payment is not successful, you can use a modified version of the following code:

add_filter( 'gfpdf_get_active_pdfs', function( $filtered, $pdfs, $entry, $form ) {
$new_filtered_pdfs = [];
foreach ( $filtered as $pdf ) {
if ( strpos( $pdf['template'], 'invoice' ) === false ) {
$new_filtered_pdfs[] = $pdf;
continue;
}
if ( ! empty( $entry['is_fulfilled'] ) ) {
$new_filtered_pdfs[] = $pdf;
}
}
return $new_filtered_pdfs;
}, 10, 4 );

Source Code

This filter is located in the Model_PDF::get_active_pdfs() method in /src/model/Model_PDF.php.

Last updated on