Keep up to date with Gravity PDF

  • This field is for validation purposes and should be left unchanged.

Jump To Section

Description #description

This method will permanently delete an existing PDF’s settings. This cannot be undone so use it carefully.

Version #version

This method was introduced in Gravity PDF 4.0.

Parameters #parameters

$form_id | integer
The Gravity Form ID
$pdf_id | string
The PDF internal identifier (found in the pid URL parameter when viewing individual PDF settings in the admin area)

Return #return

boolean
True on success, false on failure

Usage #usage

The following snippet shows you how to delete an existing PDF:

add_action( 'init', function() {
    if ( class_exists( 'GPDFAPI' ) ) {
        /* Delete the PDF on form #2 */
        if( GPDFAPI::delete_pdf( 2, '56c14c955d989' ) ) {
            //PDF deleted successfully
        }
    }
} );

Source Code #source-code

This method is located in api.php.

Signup for the latest Gravity PDF news, tips and updates

  • This field is for validation purposes and should be left unchanged.
Scroll To Top