aromarious / wp-dotenv
辅助脚本,使 WordPress 能够使用 dotenv 配置文件,类似于 Laravel 5,使用 scottjs/wp-dotenv 代码。感谢 scottjs
Requires
- vlucas/phpdotenv: ^2.2
README
这是 scottjs/wp-dotenv 的私人修订版 scottjs/wp-dotenv。 感谢 scottjs。
受 Laravel 5 启发,WP Dotenv 允许 WordPress 使用 .env 文件进行配置,而不是 wp-config.php。如果你打算使用 scottjs/db-sync 或 scottjs/helper-scripts 与 WordPress 一起使用,原始版本很有用,但这个版本省略了该功能。
要求
- Composer
- PHP >= 5.3.9
- 本地开发环境,例如 Vagrant。
注意
- 这些脚本需要在项目根目录中创建一个 .env 配置文件,此文件将用于配置 WordPress。
- 运行此脚本将用修改后的版本替换现有的
wp-config.php,以使用 .env 文件。
安装
从项目的根目录运行 composer require "aromarious/wp-dotenv:1.*"。
或者,你可以手动将 "aromarious/wp-dotenv": "1.*" 添加到你的 composer.json 文件中
"require": {
"aromarious/wp-dotenv": "1.*"
},
然后将以下脚本添加到你的 composer.json 文件中
"scripts": {
"generate-config" : [
"vendor/aromarious/wp-dotenv/generate-config.sh"
],
"generate-config-with-salts" : [
"vendor/aromarious/wp-dotenv/generate-config.sh salts"
],
"generate-index" : [
"vendor/aromarious/wp-dotenv/generate-index.sh"
]
}
从项目的根目录运行 composer update 命令。
在项目的根目录中创建一个 .env 文件,并添加/更新以下配置选项
APP_DOCROOT=
APP_CORE=
APP_DEBUG=false
APP_HOSTNAME=example.local
APP_SSL=false
DB_HOST=localhost
DB_DATABASE=example
DB_USERNAME=root
DB_PASSWORD=password
DISABLE_AUTOMATIC_UPDATER=true
使用方法
从项目的根目录,您将能够运行以下 composer 命令
-
composer generate-config - 此命令将生成一个修改后的 wp-config.php 文件,允许 WordPress 使用 .env 文件。这需要在 .env 文件中设置
APP_DOCROOT。 -
composer generate-config-with-salts - 如上所述,但还会自动生成盐。这是一个在启动新项目时非常有用的命令,但可以在任何时间使用。
-
*composer generate-index - 此命令将定位 index.php 文件到
APP_DOCROOT。这需要在 .env 文件中设置APP_DOCROOT和APP_CORE。
配置
以下是对 .env 文件中使用的每个配置选项的解释。
-
APP_ENV - 当设置为
local时,WordPress 管理面板将在管理面板中显示升级插件和 WordPress 文件的按钮。当设置为production(除了local)时,通过管理面板启用插件/软件的能力被禁用。 -
APP_DOCROOT - 由 composer generate-config 需要,它应该相对于你的项目根文件夹,指向配置文档根的位置。它应该以斜杠开始,不包含尾随斜杠。如果不适用,请留空。例如:
/public。 -
APP_CORE - 如果 WP 核心文件位于相对于
APP_DOCROOT的子目录中,则需要此选项。它应该指向 WP 核心安装的目录。它应该以斜杠开始,不包含尾随斜杠。如果不适用,请留空。例如:/wp。 -
APP_DEBUG - 允许您启用或禁用WP调试。选项:
true或false。 -
APP_HOSTNAME - 必需项。提供URL的主机部分。(自动配置会导致wp-cli无法工作)
-
APP_SSL - 允许您强制WordPress使用SSL协议并处理重定向。选项:
true或false。 -
DB_... - 提供设置本地数据库连接详情的选项。
-
DISABLE_AUTOMATIC_UPDATER - 禁用自动更新。这会影响WordPress核心、主题和插件。选项:
true或false。 -
DISABLE_WP_CRON - 禁用WP_CRON功能。选项:
true或false。默认:false