钩子文档

pre_uninstall_plugin

💡 云策文档标注

概述

pre_uninstall_plugin 是一个 WordPress 动作钩子,在 uninstall_plugin() 函数中触发,用于在插件卸载前执行自定义代码。

关键要点

  • 触发时机:在 uninstall_plugin() 函数中,插件卸载之前立即触发。
  • 参数:$plugin(插件文件相对于 plugins 目录的路径字符串)和 $uninstallable_plugins(可卸载插件数组)。
  • 用途:允许开发者在插件卸载前添加自定义逻辑,如清理数据或执行其他操作。
  • 相关函数:与 uninstall_plugin() 函数关联,位于 wp-admin/includes/plugin.php 文件中。
  • 版本历史:从 WordPress 4.5.0 版本开始引入。

📄 原文内容

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

Parameters

$pluginstring
Path to the plugin file relative to the plugins directory.
$uninstallable_pluginsarray
Uninstallable plugins.

Source

do_action( 'pre_uninstall_plugin', $plugin, $uninstallable_plugins );

Changelog

Version Description
4.5.0 Introduced.