Skip to main content
Version: v6

Gravity PDF API – update_plugin_option()

Description​

This method allows you to update a global Gravity PDF setting. If the option doesn't exist it will be added.

Version​

This method was introduced in Gravity PDF 4.0.

Parameters​

$key | string​

  • The global PDF setting ID. Best to prefix this value to prevent conflict.

$value | mixed​

  • Whatever value you want to store.

Return​

boolean​

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

Usage​

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

add_action( 'init', function() {
    if ( class_exists( 'GPDFAPI' ) ) {
        $option = GPDFAPI::update_plugin_option( 'prefix_option_name', 'My Value' );

        if( true === $option ) {
            // Option Successfully Added
        } else {
            // There was a problem updating the database with your new option
        }
    }
} );

Source Code​

This method is located in api.php.

Last updated on