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 allows you to deleted a global Gravity PDF setting. This is permanent and cannot be undone.

Version #version

This method was introduced in Gravity PDF 4.0.

Parameters #parameters

$key | string
The global PDF setting ID.

Return #return

boolean
True on success, false if database failed to update .

Usage #usage

The following snippet shows you how to remove a PDF global option and correctly handle any errors:

add_action( 'init', function() {
    if ( class_exists( 'GPDFAPI' ) ) {

        if( GPDFAPI::delete_plugin_option( 'prefix_option_name' ) ) {
            // Option Deleted
        } else {
            // There was a problem removing the option from the database
        }
    }
} );

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