README

一些辅助工具，用于标准化我们在项目中使用高级自定义字段（ACF）的方式。

简介

本包旨在标准化我们在项目中使用高级自定义字段（ACF）的方式。

这使得处理 ACF JSON 文件、隐藏 ACF 管理区域以及检查 ACF 是否未安装或激活在网站上变得容易。

入门

要开始使用，请按照以下在安装中描述的说明进行安装。

要使用该包，请参阅使用

安装

使用 composer 安装。

composer require morningtrain/wp-acf-helper

使用

添加 JSON 文件夹

为了添加 ACF 应该查找 JSON 字段组的文件夹

// Add folder to look for JSON files in ./resources/acf-fields
\Morningtrain\WP\ACFHelper\ACFHelper::registerJsonFolder(__DIR__ . '/resources/acf-fields');

使用 JSON 文件夹作为保存文件夹

为了将添加的 JSON 文件夹用作 ACF 在返回的 JsonPath 对象上使用 useAsSaveFolder 方法时使用的文件夹。您可以可选地设置一个命名空间，用于在多个项目设置保存文件夹时强制在特定文件夹中保存。

注意：ACF 不会创建文件夹，因此在 ACF 保存到文件夹之前，文件夹必须存在。

// Add folder to look for JSON files in ./resources/acf-fields and use it as save folder
\Morningtrain\WP\ACFHelper\ACFHelper::registerJsonFolder(__DIR__ . '/resources/acf-fields')->useAsSaveFolder('some_namespace');

如果您将强制在文件夹中保存，请定义一个在 wp-config.php 中设置的命名空间的常量。

define('ACF_SAVE_FOLDER', 'some_namespace');

隐藏管理区域

从 WP 后端隐藏管理区域。

\Morningtrain\WP\ACFHelper\ACFHelper::hideAdmin();

这将隐藏 ACF 从 WP 管理。

除了特定环境外隐藏管理区域

您可以通过在 wp-config.php 中的 WP_ENVIRONMENT_TYPE 定义特定环境来隐藏管理区域。

\Morningtrain\WP\ACFHelper\ACFHelper::hideAdminExceptOn([
    'local',
    'development'
]);

可能的值是 'local'、'development'、'staging' 和 'production'。

要定义环境，请将以下内容添加到 wp-config.php

define('WP_ENVIRONMENT_TYPE', 'local');

检查 ACF 是否已安装和激活

为了检查 ACF 是否已激活

// Abort if ACF is not activated
if(!\Morningtrain\WP\ACFHelper\ACFHelper::isACFActivated()) {
    return;
}

致谢

许可

MIT 许可证（MIT）。有关更多信息，请参阅许可文件。

morningtrain / wp-acf-helper

维护者

详细信息