添加重要更新提示到 WordPress插件列表页面

文 / @WordPress主题

WordPress插件更新提示功能添加方法

作为一名WordPress插件开发者,我们可能需要对插件进行更新,但这些更新有可能不兼容以前版本,这时候就需要提醒插件用户注意这些更新,以免用户遇到问题。在WordPress4.3之前的版本中,插件readme.txt文件中的“UpgradeNotice”信息可以直接显示在插件列表中,在新版本中却被取消了,这给用户造成了很大的困扰。

因此,我们需要学会通过API在插件中添加版本更新提示,本文将为大家介绍一下添加方法。

插件readme.txt里面的更新提示示例

下面是一个WizhiMultiFilter插件的更新提示:

##UpgradeNotice##

###1.8###
此版本将弃用直接使用类新建多条件查询的方法,更新前请先检查自己的主题。

###1.7###
新版本需要PHP5.4以上的版本才能正常运行,如果PHP版本低于5.4,请不要更新此版本,否则将使您的站点出现致命错误而不可访问。

添加并显示版本更新提示到插件列表页面

我们可以使用in_plugin_update_message-{$plugin_main_file}钩子实现在插件列表页面上显示版本更新提示。

//添加插件更新提示
add_action('in_plugin_update_message-wizhi-multi-filters/wizhi-multi-filter.php','showUpgradeNotification',10,2);

functionshowUpgradeNotification($currentPluginMetadata,$newPluginMetadata){
//检查"upgrade_notice"数据并显示
if(isset($newPluginMetadata->upgrade_notice)&&strlen(trim($newPluginMetadata->upgrade_notice))>0){
echo'<pstyle="background-color:#d54e21;padding:10px;color:#f9f9f9;margin-top:10px"><strong>Important Upgrade Notice:</strong>';
echoesc_html($newPluginMetadata->upgrade_notice),'</p>';
}
}

上面的代码中,$newPluginMetadata是从WordPress插件仓库里面直接读取的,而不是已经安装的插件里面的数据,所以,我们至少要更新两个版本才能看到上面的提示:一个是旧版插件,一个是包含更新提示的新版插件。

总结

尽管WordPress官方没有明确介绍这个功能,但插件更新提示是一个非常重要的特性。我们可以通过API在插件中添加版本更新提示,以帮助用户更好地了解插件的更新信息。

添加UTHEME为好友
扫码添加UTHEME微信为好友
· 分享WordPress相关技术文章,主题上新与优惠动态早知道。
· 微信端最大WordPress社群,限时免费入群。