README

Syllables 是用于 WordPress 开发的辅助类和函数。

安装

要使用 Composer 将此库作为 WordPress 项目的依赖项安装，请运行以下命令以获取最新版本

$ composer require goblindegook/syllables

默认情况下，Composer 将 Syllables 安装在 wp-content/plugins/syllables 目录中。然后您可以在仪表板上登录，导航到“插件”并激活“Syllables”。

尽管 Syllables 存在为插件，但它本身并不执行任何操作，但它确实使其类和函数可用，这样您就不必在每一个插件或主题中将其作为依赖项包含。

要将 Syllables 安装为必用插件（用户无法关闭），请确保您的网站 composer.json 文件包含一个 extra.installer-paths 部分，并将 goblindegook/syllables 设置为在正确的目录中安装

"extra": {
    "installer-paths": {
        "wp-content/mu-plugins/syllables/": ["goblindegook/syllables"]
    }
}

运行 Composer 安装依赖项将把 Syllables 放入 wp-content/mu-plugins/syllables 文件夹中。

现在，由于 WordPress 不在子文件夹中查找必用插件，您还需要将提供的 syllables-mu.php 文件复制到父目录中。

$ cd /path/to/wp-content/mu-plugins/syllables
$ cp syllables-mu.php ..

Syllables 使用 Gulp 通过以下任务来自动化构建

Syllables 在 GPL 版本 2.0 或任何后续版本下授权。见 LICENSE。