Skip to main content
Version: v6

gfpdf_mpdf_init_class

Description​

This filter gives you access to the mPDF object right after it has been initialised and before the rest of the initial setup has been done (RTL mode, PDF format, security, and display mode).

caution

If using a Core or Universal PDF template, writing content directly to the PDF using this filter can break the Header and Footer display.

Parameters​

$mpdf | object​

  • The initialised mPDF class that handles the PDF generation

$form | array​

  • The current Gravity Forms array

$entry | array​

  • The raw Gravity Forms Entry array.

$settings | array​

  • The current PDF settings being processed

$Helper_PDF | object​

  • The initialised \GFPDF\Helper\Helper_PDF class

Usage​

Write content directly to the PDF:

add_filter( 'gfpdf_mpdf_init_class', function( $mpdf, $form, $entry, $settings, $Helper_PDF ) {
    $mpdf->WriteHTML( 'This is included right at the beginning of the document...' );

    return $mpdf;

}, 10, 5 );

Source Code​

This filter is located in the Helper_PDF::begin_pdf() method of /src/helper/Helper_PDF.php.