uninstall_plugin( string $plugin ): true|void

Description

Parameters

$pluginstring

Path to the plugin file relative to the plugins directory.

Return

true|void

True if a plugin's uninstall.php file has been found and included. Void otherwise.

Hooks fired · 2

2 hooks fire while uninstall_plugin() runs, in this order:

1. 1
   do_action( pre_uninstall_plugin )actionline 1315 (+13 into the body)

   Fires in uninstall_plugin() immediately before the plugin is uninstalled.

2. 2
   do_action( uninstall_{$file} )actionline 1351 (+49 into the body)

   Fires in uninstall_plugin() once the plugin has been uninstalled.

Uses · 6

• plugin_basename()Gets the basename of a plugin.
• get_option()Retrieves an option value based on an option name.
• do_action()Calls the callback functions that have been added to an action hook.
• update_option()Updates the value of an option that was already added.
• wp_register_plugin_realpath()Register a plugin's real path.
• add_action()Adds a callback function to an action hook.

Used by · 1

• delete_plugins()Removes directory and files of a plugin for a list of plugins.

Source

View on Trac ↗View on GitHub ↗

1302function uninstall_plugin( $plugin ) {1303	$file = plugin_basename( $plugin );1304 1305	$uninstallable_plugins = (array) get_option( 'uninstall_plugins' );1306 1307	/**1308	 * Fires in uninstall_plugin() immediately before the plugin is uninstalled.1309	 *1310	 * @since 4.5.01311	 *1312	 * @param string $plugin                Path to the plugin file relative to the plugins directory.1313	 * @param array  $uninstallable_plugins Uninstallable plugins.1314	 */1315	do_action( 'pre_uninstall_plugin', $plugin, $uninstallable_plugins );1316 1317	if ( file_exists( WP_PLUGIN_DIR . '/' . dirname( $file ) . '/uninstall.php' ) ) {1318		if ( isset( $uninstallable_plugins[ $file ] ) ) {1319			unset( $uninstallable_plugins[ $file ] );1320			update_option( 'uninstall_plugins', $uninstallable_plugins );1321		}1322		unset( $uninstallable_plugins );1323 1324		define( 'WP_UNINSTALL_PLUGIN', $file );1325 1326		wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file );1327		include_once WP_PLUGIN_DIR . '/' . dirname( $file ) . '/uninstall.php';1328 1329		return true;1330	}1331 1332	if ( isset( $uninstallable_plugins[ $file ] ) ) {1333		$callable = $uninstallable_plugins[ $file ];1334		unset( $uninstallable_plugins[ $file ] );1335		update_option( 'uninstall_plugins', $uninstallable_plugins );1336		unset( $uninstallable_plugins );1337 1338		wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file );1339		include_once WP_PLUGIN_DIR . '/' . $file;1340 1341		add_action( "uninstall_{$file}", $callable );1342 1343		/**1344		 * Fires in uninstall_plugin() once the plugin has been uninstalled.1345		 *1346		 * The action concatenates the 'uninstall_' prefix with the basename of the1347		 * plugin passed to uninstall_plugin() to create a dynamically-named action.1348		 *1349		 * @since 2.7.01350		 */1351		do_action( "uninstall_{$file}" );1352	}1353}

History

Introduced in 2.7.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-admin/includes/plugin.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.