Uninstall and cleanup hooks in Wordpress - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ component_behavior

intermediate

What happens when the uninstall.php file is missing in a plugin?

In WordPress, a plugin uses an uninstall.php file to clean up data when uninstalled. What happens if this file is missing and the plugin is uninstalled?

A No cleanup code runs automatically; plugin data remains in the database.

B WordPress will run the uninstall hook registered in the main plugin file instead.

C WordPress throws an error and prevents uninstallation.

D WordPress deletes all plugin data automatically without any code.

💡 Hint

Think about what WordPress does by default without explicit uninstall instructions.

If the uninstall.php file is missing and no uninstall hook is registered, WordPress does not run any cleanup code automatically. Plugin data remains in the database until manually removed.

📝 Syntax

intermediate

Which uninstall hook registration is correct?

You want to register an uninstall hook in your main plugin file to clean up options. Which code snippet correctly registers the uninstall hook?

A register_hook('uninstall_plugin', 'my_plugin_cleanup');

B add_action('uninstall', 'my_plugin_cleanup');

C add_uninstall_hook('my_plugin_cleanup');

D register_uninstall_hook(__FILE__, 'my_plugin_cleanup');

💡 Hint

Look for the exact WordPress function name and parameters.

The correct function to register an uninstall hook is register_uninstall_hook with the plugin file path and callback function.

🔧 Debug

advanced

Why does the uninstall hook not run when uninstalling the plugin?

Consider this uninstall.php file content:

if (!defined('WP_UNINSTALL_PLUGIN')) {
    exit();
}

delete_option('my_plugin_option');

Why might the uninstall hook not run when uninstalling the plugin?

Wordpress

if (!defined('WP_UNINSTALL_PLUGIN')) {
    exit();
}

delete_option('my_plugin_option');

A The delete_option function is misspelled, causing a fatal error.

B The constant WP_UNINSTALL_PLUGIN is not defined during uninstall, so the script exits early.

C The uninstall.php file is not in the plugin root folder, so WordPress does not find it.

D The uninstall hook requires a function wrapper around delete_option to run.

💡 Hint

Check the file location and how WordPress detects uninstall.php.

WordPress only runs uninstall.php if it is located in the root folder of the plugin. If placed elsewhere, it won't run and no cleanup happens.

❓ state_output

advanced

What is the state of options after uninstall hook runs?

A plugin registers this uninstall hook:

function cleanup() {
    delete_option('plugin_setting');
    delete_option('plugin_cache');
}
register_uninstall_hook(__FILE__, 'cleanup');

After uninstalling the plugin, what happens to these options?

Wordpress

function cleanup() {
    delete_option('plugin_setting');
    delete_option('plugin_cache');
}
register_uninstall_hook(__FILE__, 'cleanup');

A Both options remain because delete_option only works during plugin activation.

B Both 'plugin_setting' and 'plugin_cache' options are removed from the database.

C Only 'plugin_setting' is removed; 'plugin_cache' remains.

D Neither option is removed because uninstall hooks do not delete options.

💡 Hint

Think about what delete_option does and when uninstall hooks run.

The uninstall hook runs the cleanup function which calls delete_option on both options, removing them from the database.

🧠 Conceptual

expert

Why use uninstall.php instead of register_uninstall_hook?

Which reason best explains why a plugin developer might prefer using an uninstall.php file over register_uninstall_hook for cleanup?

A uninstall.php runs even if the plugin is deleted without deactivation, ensuring cleanup always happens.

B register_uninstall_hook runs faster and is preferred for performance reasons.

C uninstall.php allows cleanup code to run during plugin activation as well.

D register_uninstall_hook requires the plugin to be active, so uninstall.php is used for inactive plugins.

💡 Hint

Consider when uninstall.php is triggered compared to uninstall hooks.

uninstall.php is executed when the plugin is deleted directly, even if not deactivated first, ensuring cleanup always runs.

Practice

1. What is the main purpose of using register_uninstall_hook in a WordPress plugin?

easy

A. To register a new shortcode for the plugin

B. To add a settings page in the admin dashboard

C. To clean up plugin data when the plugin is deleted

D. To enqueue scripts and styles for the plugin

Solution

1. Step 1: Understand the role of uninstall hooks

   Uninstall hooks are designed to remove all plugin data when the plugin is deleted to keep the site clean.

2. Step 2: Identify the function of register_uninstall_hook

   This function links a cleanup function that runs on plugin deletion to remove options, transients, and custom tables.

3. Final Answer:

   To clean up plugin data when the plugin is deleted -> Option C

4. Quick Check:

   Uninstall hook purpose = clean up data [OK]

Hint: Uninstall hooks remove plugin data on deletion [OK]

Common Mistakes:

• Confusing uninstall hooks with activation hooks
• Thinking uninstall hooks add features instead of cleaning
• Using uninstall hook to enqueue scripts

2. Which of the following is the correct way to register an uninstall hook in a WordPress plugin?

easy

A. register_activation_hook(__FILE__, 'my_cleanup_function');

B. add_action('uninstall_plugin', 'my_cleanup_function');

C. add_filter('uninstall_hook', 'my_cleanup_function');

D. register_uninstall_hook(__FILE__, 'my_cleanup_function');

Solution

1. Step 1: Recall the correct function for uninstall hooks

   The correct function to register an uninstall hook is register_uninstall_hook with the plugin file and cleanup function.

2. Step 2: Check the syntax of each option

   register_uninstall_hook(__FILE__, 'my_cleanup_function'); uses the correct function and parameters. Options A, B, and D use incorrect functions or hooks.

3. Final Answer:

   register_uninstall_hook(__FILE__, 'my_cleanup_function'); -> Option D

4. Quick Check:

   Correct uninstall hook syntax = register_uninstall_hook(__FILE__, 'my_cleanup_function'); [OK]

Hint: Use register_uninstall_hook with __FILE__ and function name [OK]

Common Mistakes:

• Using activation hook instead of uninstall hook
• Using add_action with wrong hook name
• Confusing filters with hooks

3. Consider this uninstall function in a plugin:

function cleanup_plugin() {
  delete_option('plugin_setting');
  delete_transient('plugin_cache');
  global $wpdb;
  $wpdb->query("DROP TABLE IF EXISTS {$wpdb->prefix}plugin_data");
}

What will happen when the plugin is uninstalled?

medium

A. All plugin data including options, transients, and custom tables will be removed

B. Only the option 'plugin_setting' will be deleted

C. The transient 'plugin_cache' will be deleted but the table remains

D. Nothing will be deleted because uninstall hooks do not run functions

Solution

1. Step 1: Analyze the cleanup function actions

   The function deletes an option, a transient, and drops a custom database table using SQL.

2. Step 2: Understand uninstall hook behavior

   When the uninstall hook calls this function, all these cleanup actions will run, removing all plugin data.

3. Final Answer:

   All plugin data including options, transients, and custom tables will be removed -> Option A

4. Quick Check:

   Cleanup function deletes all data = All plugin data including options, transients, and custom tables will be removed [OK]

Hint: Cleanup function removes all data types explicitly [OK]

Common Mistakes:

• Assuming uninstall hooks do not run cleanup functions
• Thinking only options or transients are deleted
• Ignoring the SQL DROP TABLE command

4. Identify the error in this uninstall hook registration:

register_uninstall_hook('my-plugin/my-plugin.php', 'cleanup_plugin');

function cleanup_plugin() {
  delete_option('my_plugin_option');
}

medium

A. The plugin file path should use __FILE__ instead of a string

B. The cleanup function name must be prefixed with 'uninstall_'

C. delete_option cannot be used in uninstall functions

D. The uninstall hook must be registered inside the cleanup function

Solution

1. Step 1: Check the first parameter of register_uninstall_hook

   The first parameter should be the plugin main file path, usually passed as __FILE__ for reliability.

2. Step 2: Understand why using a string path is problematic

   Using a string path can cause the hook not to trigger if the path is incorrect or changes; __FILE__ ensures correct reference.

3. Final Answer:

   The plugin file path should use __FILE__ instead of a string -> Option A

4. Quick Check:

   Use __FILE__ for plugin path in uninstall hook [OK]

Hint: Always use __FILE__ for plugin path in uninstall hook [OK]

Common Mistakes:

• Using string path instead of __FILE__
• Thinking function name must have uninstall prefix
• Registering hook inside cleanup function

5. You want to ensure your plugin cleans up all its data on uninstall, including options, transients, and a custom table named wp_custom_data. Which of the following uninstall functions correctly performs this cleanup?

hard

A. function uninstall_plugin() {
delete_option('plugin_option');
delete_transient('plugin_transient');
global $wpdb;
$wpdb->query("DROP TABLE wp_custom_data");
}

B. function uninstall_plugin() {
delete_option('plugin_option');
delete_transient('plugin_transient');
global $wpdb;
$wpdb->query("DROP TABLE IF EXISTS wp_custom_data");
}

C. function uninstall_plugin() {
delete_option('plugin_option');
delete_transient('plugin_transient');
global $wpdb;
$wpdb->query("DELETE FROM wp_custom_data");
}

D. function uninstall_plugin() {
delete_option('plugin_option');
delete_transient('plugin_transient');
}

Solution

1. Step 1: Review each cleanup action

   function uninstall_plugin() { delete_option('plugin_option'); delete_transient('plugin_transient'); global $wpdb; $wpdb->query("DROP TABLE IF EXISTS wp_custom_data"); } deletes the option, transient, and drops the custom table safely using IF EXISTS.

2. Step 2: Compare with other options

   function uninstall_plugin() { delete_option('plugin_option'); delete_transient('plugin_transient'); global $wpdb; $wpdb->query("DROP TABLE wp_custom_data"); } drops table without IF EXISTS (may cause error if table missing). function uninstall_plugin() { delete_option('plugin_option'); delete_transient('plugin_transient'); global $wpdb; $wpdb->query("DELETE FROM wp_custom_data"); } deletes rows but not table. function uninstall_plugin() { delete_option('plugin_option'); delete_transient('plugin_transient'); } misses table cleanup.

3. Final Answer:

   function uninstall_plugin() { delete_option('plugin_option'); delete_transient('plugin_transient'); global $wpdb; $wpdb->query("DROP TABLE IF EXISTS wp_custom_data"); } -> Option B

4. Quick Check:

   Safe drop table + delete option and transient = function uninstall_plugin() { delete_option('plugin_option'); delete_transient('plugin_transient'); global $wpdb; $wpdb->query("DROP TABLE IF EXISTS wp_custom_data"); } [OK]

Hint: Use DROP TABLE IF EXISTS to safely remove custom tables [OK]

Common Mistakes:

• Dropping table without IF EXISTS causing errors
• Deleting rows instead of dropping table
• Forgetting to remove custom tables