morrislaptop / advanced-custom-fields-wpcli
通过 WP-CLI 管理高级自定义字段
Requires (Dev)
- behat/behat: ^3.2
- phpunit/phpunit: ^5.6
- squizlabs/php_codesniffer: 2.5.*
- wp-coding-standards/wpcs: 0.8.*
- wpreadme2markdown/wpreadme2markdown: *
- dev-master
- 3.0.0
- v2.0.x-dev
- 2.0.0
- v1.2.x-dev
- 1.2.1
- 1.2.0
- dev-fix/import-runtime
- dev-fix/disable-filters-before-export
- dev-fix/fix-release-script
- dev-fix/feedback-readme
- dev-hotfix/readme_code_blocks
- dev-release/version3
- dev-feature/add-all-to-import
- dev-fix/feedback-release-script
- dev-fix/feedback-general
- dev-feature/new-readme-in-md-and-txt
- dev-fix/no-longer-support-acf4
- dev-feature/release_script
- dev-feature/unittest
- dev-hotfix/wp_get_sites
- dev-feature/refactor_cli
- dev-feature/version2
- dev-develop
This package is auto-updated.
Last update: 2024-08-26 03:51:19 UTC
README
描述
高级自定义字段 WP-CLI 帮助您通过 WP-CLI 管理字段组。我们启动此项目的目的是为了使使用高级自定义字段 Pro 插件的 WordPress 项目开发者工作更加轻松。现在,字段可以轻松导入、导出,并通过 SVN、GIT 或类似系统共享。
安装
要求
- 高级自定义字段 5 Pro 插件
wp-cli
http://wp-cli.org/
如何安装
按照 http://wp-cli.org/ 中的说明安装 WP-CLI
使用 composer: (目前不可用,直到我们在 wordpress.org/plugins 上发布插件)
composer require wpackagist-plugin/advanced-custom-fields-wpcli
通过 GIT 克隆到插件目录
git clone https://github.com/hoppinger/advanced-custom-fields-wpcli.git
WordPress 插件安装:下载 zip 文件并将文件放入插件目录。
- 在插件菜单中激活此插件或使用
wp plugin activate advanced-custom-fields-wpcli
在终端转到您的 WordPress 目录并运行
wp acf
以检查一切是否正常工作。
当插件启用时,在您的注册路径上的文件系统中找到的任何导出的字段组将在运行时添加到 WordPress。如果您想禁用此行为,可以删除 acf_wpcli_register_groups
操作
remove_action('plugins_loaded', 'acf_wpcli_register_groups');
命令
此项目向 wp-cli
添加了 acf
命令,具有以下子命令
帮助
wp acf
打印帮助概述,并可作为默认测试来查看插件是否正常工作。
导出
将字段组导出为目录中设置的 json 文件。
wp acf export
出于测试目的等,您也可以使用 --export_path
参数显式定义导出目录,而不应用过滤器。
wp acf export --export_path=acf-exports/
如果您想一次性导出所有字段组,可以使用
wp acf export --all
导入
wp acf import
从选项菜单导入所有或特定字段
清理
wp acf clean
从数据库中删除所有高级自定义字段记录。在您从 UI 编辑字段组并导出更改之后执行此操作。警告:此操作不可逆,请谨慎使用
过滤器
acfwpcli_fieldgroup_paths
acfwpcli_fieldgroup_paths 允许您添加更多路径,ACF-CLI 应从这些路径加载/导出。您应该 始终至少添加一个路径 到此过滤器。
add_filter( 'acfwpcli_fieldgroup_paths', 'add_plugin_path' );
public function add_plugin_path( $paths ) {
$paths['my_plugin'] = MY_PLUGIN_ROOT . '/lib/field-groups/';
return $paths;
}
单元测试
要测试插件更改,您可以使用单元测试。首先确保安装了所有必要的依赖项,如果没有,运行
composer install
您需要一个全新的 WordPress 安装来确保测试独立于您的 WordPress 安装和数据库运行。要创建用于测试的 WordPress 安装,请运行以下命令
bash bin/test_wp_install.sh wordpress_test db_username db_password localhost latest
其中 'wordpress_test' 是用于运行测试的数据库的名称。确保此数据库不存在或可以被删除。如果数据库已存在,脚本将询问您是否可以删除数据库。'Latest' 可以更改,如果您想使用特定的 WordPress 版本进行测试,例如 3.6.2。
安装后,您可以使用以下命令开始运行测试
vendor/bin/behat
这将运行所有测试。这些测试包括所有类型的字段导入和导出、清理、一个字段组中的多个字段以及菜单选项的测试。如果您想运行一个特定的测试,可以通过以下方式执行:
vendor/bin/behat features/testname.feature
如果您需要不同的测试,可以创建自己的测试并将其添加到功能文件夹中的功能。
升级通知
3.0
- 在更新之前,请确保已导入所有自定义字段。
- 请确保您正在使用ACF5,ACF4不受支持。
- 更新插件
- 将过滤器添加到您的项目中(参见 过滤器)
- 导出您的字段
- 删除不必要的文件,如旧导入目录、PHP文件和JSON文件。
变更日志
3.0
- 修复:导入不再创建重复项
- 添加behat和PHPUnit的单元测试
2.0
- 移除了uniqid功能(不再需要)。
- 修复:现在优先使用数据库字段组而不是导出的字段组。
- 清理了遗留的xml导入/导出库。
- 添加命名空间。
- 清理了所有替代表示法的使用。
- 多站现在正确使用全局--url参数。
- 添加了更多注释和版本信息。
- 移除了对wp-importer的依赖。
- 添加了对composer安装的支持。
- 弃用XML支持,欢迎JSON。