Yogesh Chauhan's Blog

How to activate and deactivate hooks in a WordPress plugin?

in WordPress on June 3, 2021

What are activation and deactivation hooks?

They are just hooks that helps perform different actions when WordPress plugins are activated or deactivated by the user.

There are few things to check or perform when a user activates a plugin. Those are routine tasks such as adding rewrite rules into .htaccess (or just in PHP file), add or update some data into a database, set some default option values for the user etc.

Same way we update or remove data and perform some other tasks when removing a plugin. The removable data include any temporary data saved by the plugin such as cache files, temp files or even directories.

Activation Hook

You can use register_activation_hook() function to set up an activation hook.

Just like this:


register_activation_hook(
  __FILE__,
  'function_to_run'
);


Deactivation Hook

You can use register_deactivation_hook() function to set up an activation hook.

Just like this:


register_deactivation_hook(
  __FILE__,
  'function_to_run'
);


The ‘__FILE__’ refers to the main plugin file.

The main plugin file is the one with plugin header comment and usually you keep these two functions inside the main file.

What if the main file doesn’t have those functions?

You just need to change the first parameter in those functions and point it to where the main plugin file is.


Example form WordPress Developers

This activation hook refreshes permalinks and get rid of 404 errors when you register a custom post type.

The deactivation hook just reverses the process.


/**
 * Register the "book" custom post type
 */
function pluginprefix_setup_post_type() {
  register_post_type( 'book', ['public' => true ] ); 
} 
add_action( 'init', 'pluginprefix_setup_post_type' );


/**
* Activate the plugin.
*/
function pluginprefix_activate() { 
  // Trigger our function that registers the custom post type plugin.
  pluginprefix_setup_post_type(); 
  // Clear the permalinks after the post type has been registered.
  flush_rewrite_rules(); 
}
register_activation_hook( __FILE__, 'pluginprefix_activate' );

/**
 * Deactivation hook.
 */
function pluginprefix_deactivate() {
  // Unregister the post type, so the rules are no longer in memory.
  unregister_post_type( 'book' );
  // Clear the permalinks to remove our post type's rules from the database.
  flush_rewrite_rules();
}
register_deactivation_hook( __FILE__, 'pluginprefix_deactivate' );



Most Read

#1 Solution to the error “Visual Studio Code can’t be opened because Apple cannot check it for malicious software” #2 How to add Read More Read Less Button using JavaScript? #3 How to check if radio button is checked or not using JavaScript? #4 Solution to “TypeError: ‘x’ is not iterable” in Angular 9 #5 PHP Login System using PDO Part 1: Create User Registration Page #6 How to uninstall Cocoapods from the Mac OS?

Recently Posted

#Apr 8 JSON.stringify() in JavaScript #Apr 7 Middleware in NextJS #Jan 17 4 advanced ways to search Colleague #Jan 16 Colleague UI Basics: The Search Area #Jan 16 Colleague UI Basics: The Context Area #Jan 16 Colleague UI Basics: Accessing the user interface
You might also like these
Solution for the error Commit failed – exit code 1 received in Desktop GithubMiscellaneousWhat are components in Angular?AngularPHP Variables ScopePHPThe fundamental difference between HAVING and WHERE clauses in PostgresPostgresThe Difference Between the echo and print Commands in PHPPHPHow to create ‘share on LinkedIn’ link using just HTML?HTML