README

whip

一个WordPress插件，用于提示用户升级软件版本（从PHP版本开始）

要求

支持所有从PHP 5.3到最新版本的PHP版本。

某些功能还需要WordPress。

• WPMessagePresenter需要WordPress或名为add_action的函数，以便挂钩到WordPress。
• PHPVersionDetector需要WordPress或名为__的函数，以翻译字符串。

安装

$ composer require yoast/whip 

用法

在WordPress中使用Whip的最简单方法是使用包含的函数来检查版本。在这种情况下，检查是否已安装PHP 5.6或更高版本

whip_wp_check_versions( array(
	'php' => '>=5.6',
) );

这将在PHP 5.3到PHP 5.5的所有插件用户上显示消息。默认情况下，该消息将在管理后台的每一页以及每位用户上显示。实现插件的用户可以根据需要限制某些用户和/或页面的显示。

作为主机添加消息

可以通过设置特定的环境变量来添加自定义消息到PHP版本消息

putenv( "WHIP_NAME_OF_HOST=Name of the host" );
putenv( "WHIP_MESSAGE_FROM_HOST_ABOUT_PHP=A message from the host" );

将来，WHIP_NAME_OF_HOST环境变量可以用于显示有关不同软件包的消息。

PHP的名称和消息也可以使用WordPress过滤器进行更改

function my_host__name_for_whip() {
	return 'Name of the host';
}
add_filter( 'whip_name_of_host', 'my_host__name_for_whip' );

function my_host__php_message_for_whip( $message ) {
	return 'A message from the host';
}
add_filter( 'whip_message_from_host_about_php', 'my_host__php_message_for_whip' );

WordPress过滤器还可以读取环境变量先前设置的值。

一般来说，过滤器与环境变量相同，但全部小写。

链接到WordPress.org托管页面

我们在yoast.com上创建了一个托管概览页面，其中只包含我们经过审查的主机。默认情况下，PHP消息链接到该页面。如果您确实希望链接到WordPress.org托管页面，这也是可能的。只需使用whip_hosting_page_url_wordpress过滤器即可。

add_filter( 'whip_hosting_page_url_wordpress', '__return_true' );

向后兼容策略

我们遵循语义版本控制，并对MAJOR版本有一个额外的严格规则。每次我们添加新方法时，我们都会进行MAJOR版本升级。我们必须这样做，因为PHP中有共享命名空间。当这个包在多个插件中使用时，我们无法安全地添加和使用方法而不升级MAJOR版本。这是因为没有新方法的版本可能会自动加载，然后发生致命错误。

这也意味着任何MAJOR版本的升级都伴随着包中每个命名空间更新。所以对于这个包的第三个版本，所有Yoast\WHIPv2命名空间都将变为Yoast\WHIPv3。这可以防止两个插件包含这个包的不同版本时发生致命错误。

更新日志

安全

如果您发现任何与安全相关的问题，请通过security@yoast.com发送电子邮件，而不是使用问题跟踪器。

致谢

• Yoast团队