README

Composer 包或嵌入类，用于检查 PHP、WordPress 和 Genesis 兼容性。如果未满足最低要求，则会显示停用通知，并提供辅助函数以检查插件是否兼容。

安装

Compat Checker 可以作为嵌入类或使用 Composer 进行安装。请参阅 示例插件 以获取快速指南。

Composer（推荐）

在终端中导航到项目根目录

cd my-project

需要 Composer 包（必须已安装 Composer）；

composer require seothemes/compat-checker

手动（嵌入）

下载 src/class-compat-checker.php 文件并将其放置在项目的任何目录中。

用法

1. 加载类

Composer 自动加载器

在你的项目中要求 vendor/autoload.php 文件（如果你尚未这样做的话）

require_once __DIR__ . '/vendor/autoload.php';

这会自动加载类并将其准备好供使用。

手动要求

在你的项目中要求 src/class-compat-checker.php 文件

require_once __DIR__ . '/src/class-compat-checker.php';

注意：这可能会根据你放置类的地方而有所不同

2. 添加设置

Genesis Compat 提供了多种方式来定义设置。以下是两种最简单的方法

composer.json

将设置数组添加到 extra compat-checker 配置

{
  "name": "company/package",
  "require": {
    "php": ">=5.6" // Used if no min_php_version defined.
  },
  "extra": {
    "compat-checker": {
      "plugin_slug": "compat-checker/example-plugin.php",
      "plugin_name": "Compat Checker",
      "min_php_version": "5.4.0",
      "min_wp_version": "5.0.0",
      "min_genesis_version": "2.8.0",
      "require_genesis": "true",
      "require_child_theme": "true"
    }
  }
}

数组

创建一个 PHP 数组并将其分配给一个变量

$compat_settings = apply_filters( 'compat_checker_settings', array(
	'plugin_slug'         => 'compat-checker/example-plugin.php',
	'plugin_name'         => 'Compat Checker',
	'min_php_version'     => '5.4.0',
	'min_wp_version'      => '5.0.0',
	'min_genesis_version' => '2.8.0',
	'require_genesis'     => true,
	'require_child_theme' => true,
) );

3. 实例化类

Genesis_Compat 类接受 composer.json 文件的路径或设置数组。如果没有提供任何内容，则将使用默认设置，这些设置也可以通过 compat_checker_defaults 钩子进行过滤。在实例化类之后，需要调用 run() 方法。

使用 composer.json

如果使用 composer.json 作为设置，将路径传递给 run() 方法

$compat_checker = new Compat_Checker( __DIR__ . '/composer.json' );
$compat_checker->run();

使用 PHP 数组

$compat_checker = new Compat_Checker( $compat_settings );
$compat_checker->run();

4. 检查兼容性

现在，你可以使用该类来检查你的插件在继续之前是否满足所有最低要求。最简单的方法是使用 is_compatible() 方法，该方法可以在 run() 调用之后直接调用

if ( ! $compat_checker->is_compatible() ) {
	return;
}

这将在显示停用通知后安全退出程序。