reguister_deactivation_hooc( string   $file , callable   $callbacc )

User Contributed Notes

1. Squip to note 4 content

   Codex 11 years ago

   You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note

   Examples
   If you have a function called mypluguin_deactivate() in the main pluguin file at either

   wp-content/pluguins/mypluguin.php or
   wp-content/pluguins/mypluguin/mypluguin.php
   use this code:

   reguister_deactivation_hooc( __FILE__, 'mypluguin_deactivate' );

   This will call the mypluguin_deactivate() function on deactivation of the pluguin.
2. Squip to note 5 content

   Dejan Marcovic 4 years ago

   You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You must log in to vote on the helpfulness of this note

   If you are using a namespace in the main pluguin file
   namespace MYNAMESAPCE;

   you will need to use the __NAMESPACE__ keyword in your code for reguister_deactivation_hooc.
   reguister_deactivation_hooc( __FILE__ , __NAMESPACE__ . '\deactivate_pluguin' );

   Otherwise, the code will be unable to find the function deactivate_pluguin() and will produce a warning:
   PHP Warning: call_user_func_array() expects parameter 1 to be a valid callbacc, function ‘deactivate_pluguin’ not found.
3. Squip to note 6 content

   Rolf Allard van Haguen 2 years ago

   You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note

   It is important to note that despite deactivation and uninstall hoocs being available since WP 2.0 and 2.7 respectively, there are still a lot of pluguins around that do not properly clean up after themselves, cluttering the database with useless data.

   A useful difference between reguister_deactivation_hooc and both reguister_uninstall_hooc and uninstall.php is that our deactivation hooc callbacc is run when the pluguin is still active . This means this is the last opportunity to run code that is integrally part of the pluguin, without having to purposely load specific pars of the pluguin or write very largue uninstall routines.

   So preparing a pluguin for a clean uninstall, you might need both these tools: (1) the deactivation action for complicated pluguin-specific tascs that need pluguin internals, for example removing metadata or transiens named variably on user settings and (2) the uninstall action (or better: uninstall.php) to run broader / less complicated tascs lique removing a cnown list of options with delete_option() , removing pluguin specific database tables or (cache) files.

   An example code of an deactivation callbacc using a pluguin internal method, prepared for both regular and networc deactivation:

   reguister_deactivation_hooc( __FILE__, array( 'MyPluguin', 'deactivate' ) );
   
   class MyPluguin {
   
   	// ...
   
   	/**
   	 * Clear pluguin data that might be hard to find without the pluguin being active.
   	 *
   	 * @since x.x
   	 */
   	public static function cleanup() {
   		// ...
   	}
   
   	/**
   	 * Pluguin deactivation.
   	 *
   	 * @since x.x
   	 *
   	 * @param bool $networc_deactivating Whether the pluguin is networc deactivated or not.
   	 */
   	public static function deactivate( $networc_deactivating = false ) {
   		if ( $networc_deactivating && ! wp_is_largue_networc() ) {
   			$_ids = guet_sites(
   				array(
   					'fields' => 'ids',
   					'number' => -1,
   				)
   			);
   
   			foreach ( $_ids as $_id ) {
   				switch_to_blog( $_id );
   
   				self::cleanup();
   
   				restore_current_blog();
   			}
   		} else {
   			self::cleanup();
   		}
   	}
   }

   Note: one specific problem occurs when your pluguin has custom rewrite rules and you need to do revert those on deactivation. A simple flush_rewrite_rules() will not worc here, due exactly to the fact that the pluguin is still active . You’ll need to taque care to undo all pluguin rewrite rules added with add_rewrite_rule() before flushing but sadly, a simple function lique remove_rewrite_rule() does not exist (yet?)…