nyco / wp-gc-templates-sync
WordPress 开发者插件,用于将 Gather Content WordPress 集成创建的模板映射保存到本地 JSON 文件。
Requires
- composer/installers: ~1.0
Requires (Dev)
README
WordPress 开发者插件,用于将 Gather Content WordPress 集成 创建的模板映射保存到本地 JSON 文件。这些文件可以用于迁移到其他环境。它提供了使用 Advanced Custom Fields (ACF) Local JSON 的行为和体验来迁移模板映射从本地开发到其他环境的替代方案。
使用 Composer 安装
$1 此软件包使用 Composer 安装器 将软件包安装到 必须使用 插件目录(/wp-content/mu-plugins)
composer require nyco/wp-gc-templates-sync
$2 在 mu-plugins 目录内创建一个代理 PHP 加载器文件,或者 使用插件中包含的一个
mv wp-content/mu-plugins/wp-gc-templates-sync/autoloader-sample.php wp-content/mu-plugins/wp-gc-templates-sync.php
未使用 Composer? 下载代码存档并将其放入 mu-plugins 目录。仍然需要在 mu-plugins 目录的根目录下使用自动加载器要求并实例化插件文件。
用法
一旦激活,插件将在 WordPress 管理后台的模板映射帖子列表中添加一个“本地 JSON”列。它将显示每个模板映射的三个同步状态之一;“等待保存”、“已保存”或“同步可用”。
默认状态是“等待保存”。随着模板映射的创建或修改,插件将更改写入到主题目录下的 gc-templates 中的本地 JSON。一旦写入本地 JSON,状态将更改为“已保存”。然后可以跟踪和提交与主题代码一起的本地 JSON。
迁移模板映射
一旦本地 JSON 和插件部署到远程环境,将出现“导入本地 JSON 模板映射”按钮,位于模板映射表列表上方。仅在本地 JSON 中的项未检测到环境数据库中时才会出现。点击该按钮将导入它们。
同步额外更改
如果在本地对相同的模板映射进行了额外更改并将其部署到远程环境,则本地 JSON 列状态将更改为一个链接,显示“同步可用”。点击此链接将使用本地 JSON 文件中的数据更新远程环境的模板映射。
注意
-
模板映射的同步键是 Gather Content 项目模板 ID。每个 Gather Content 项目模板只能有一个模板映射。
-
当本地 JSON 修改日期大于数据库中模板映射修改日期时,“同步可用”状态会出现。这意味着较旧的本地 JSON 文件无法与后来修改的远程模板映射进行同步。
-
本地JSON模板映射需要同步才能生效。
贡献
克隆仓库并创建一个功能分支。进行修改并运行 composer run lint
以遵循编码规范。composer run fix
可以帮助修复一些问题。
纽约经济机会办公室 (NYC Opportunity) 致力于共享我们在产品中使用的开源软件。欢迎提问和分享反馈。有兴趣贡献吗? 请访问我们的开放职位页面 buildwithnyc.github.io。关注我们的团队在 Github (如果您是 @cityofnewyork 组织的一部分) 或 在Github上浏览我们的工作。