Manage the version of your plugin options

Effectively managing the database version is crucial for any WordPress plugin developer. Whether it’s to add new features or improve performance, updating the underlying data structures of your plugin must be done methodically. In this article, we will explore how to use the db_version option in WordPress to check, update, and initialize the database version of your plugin. You will also learn how to automate these processes during your plugin’s activation, ensuring a smooth transition for your users.

Check the Database Version

You can retrieve the current database version using the get_option() function:

PHP

$db_version = get_option('db_version');
echo 'Current DB Version: ' . $db_version;

Update the Database Version

If you need to update your plugin’s database, you can check the current version and make the necessary changes:

PHP

function my_plugin_update_db_check() {
    // Current database version
    $current_db_version = get_option('my_plugin_db_version');

    // Expected database version
    $plugin_db_version = '1.1';

    // If the current version is different from the expected version, perform updates
    if ($current_db_version != $plugin_db_version) {
        // Make necessary database changes
        my_plugin_update_db();

        // Update the database version in the options
        update_option('my_plugin_db_version', $plugin_db_version);
    }
}

// Function to make necessary database changes
function my_plugin_update_db() {
    global $wpdb;

    // Example update: adding a new table
    $table_name = $wpdb->prefix . 'my_plugin_table';
    $charset_collate = $wpdb->get_charset_collate();

    $sql = "CREATE TABLE $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        name tinytext NOT NULL,
        value text NOT NULL,
        PRIMARY KEY (id)
    ) $charset_collate;";

    require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
    dbDelta($sql);
}

// Add an action to check and update the database when the plugin is activated
register_activation_hook(__FILE__, 'my_plugin_update_db_check');

Initialize the Database Version

When initially activating your plugin, you can set the database version:

PHP

function my_plugin_activate() {
    // Set the database version
    $plugin_db_version = '1.0';
    add_option('my_plugin_db_version', $plugin_db_version);

    // Perform necessary database initializations
    my_plugin_update_db_check();
}

// Add an action to initialize the database when the plugin is activated
register_activation_hook(__FILE__, 'my_plugin_activate');

Explanations

get_option('db_version'): Retrieves the current database version.
update_option('my_plugin_db_version', $version): Updates the database version for your plugin.
register_activation_hook(__FILE__, 'function_name'): Adds an action to be performed when the plugin is activated.

By using these functions, you can effectively manage your WordPress plugin’s database updates using the db_version option or a plugin-specific option.

Optimize your plugins: WordPress database version management

Check the Database Version

Update the Database Version

Initialize the Database Version

Explanations