函数文档

wp_update_plugin()

💡 云策文档标注

概述

wp_update_plugin() 是一个已弃用的 WordPress 函数,用于启动插件更新过程。自 3.7.0 版本起被弃用,建议直接实例化 Plugin_Upgrader 类并调用其 'upgrade' 方法。

关键要点

  • wp_update_plugin() 函数自 3.7.0 版本起被弃用,不应在新代码中使用。
  • 替代方案是直接创建 Plugin_Upgrader 实例并调用其 upgrade 方法。
  • 该函数自 2.8.0 版本起已不再使用,主要用于向后兼容。
  • 函数内部使用 _deprecated_function() 标记弃用,并可能通过 add_filter() 添加反馈回调。

代码示例

function wp_update_plugin($plugin, $feedback = '') {
    _deprecated_function( __FUNCTION__, '3.7.0', 'new Plugin_Upgrader();' );

    if ( !empty($feedback) )
        add_filter('update_feedback', $feedback);

    require ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
    $upgrader = new Plugin_Upgrader();
    return $upgrader->upgrade($plugin);
}

注意事项

  • 在开发新功能时,应避免使用此弃用函数,转而使用 Plugin_Upgrader 类。
  • 如果维护旧代码,需注意此函数可能触发弃用警告,建议更新以遵循最佳实践。
  • 相关函数包括 _deprecated_function() 和 add_filter(),用于处理弃用和钩子操作。

📄 原文内容

This was once used to kick-off the Plugin Updater.

Description

Deprecated in favor of instantiating a Plugin_Upgrader instance directly, and calling the ‘upgrade’ method.
Unused since 2.8.0.

See also

Source

function wp_update_plugin($plugin, $feedback = '') {
	_deprecated_function( __FUNCTION__, '3.7.0', 'new Plugin_Upgrader();' );

	if ( !empty($feedback) )
		add_filter('update_feedback', $feedback);

	require ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
	$upgrader = new Plugin_Upgrader();
	return $upgrader->upgrade($plugin);
}

Changelog

Version Description
3.7.0 Deprecated. Use Plugin_Upgrader
2.5.0 Introduced.