acf-builder - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #llm #machine-learning #deep-learning #macos #java #cli #kubernetes #pytorch #ios #mcp #openai

acf-builder

(★ 838)

An Advanced Custom Field Configuration Builder

파일 탐색기

최종 버전 다운로드 (.zip)

- - main.yml
- - CanSingularize.php
- - ConditionalField.php
  - ConditionalLogic.php
  - FlexibleContentLayout.php
  - IterativeTransform.php
  - NamespaceFieldKey.php
  - RecursiveTransform.php
  - Transform.php
- AccordionBuilder.php
- Builder.php
- ChoiceFieldBuilder.php
- ConditionalBuilder.php
- FieldBuilder.php
- FieldManager.php
- FieldNameCollisionException.php
- FieldNotFoundException.php
- FieldsBuilder.php
- FlexibleContentBuilder.php
- GroupBuilder.php
- LayoutNotFoundException.php
- LocationBuilder.php
- ModifyFieldReturnTypeException.php
- NamedBuilder.php
- ParentDelegationBuilder.php
- RepeaterBuilder.php
- TabBuilder.php
- - ConditionalFieldTest.php
  - ConditionalLogicTest.php
  - FlexibleContentLayoutTest.php
  - NamespaceFieldKeyTest.php
- AccordionBuilderTest.php
- ChoiceFieldBuilderTest.php
- ConditionalBuilderTest.php
- FieldBuilderTest.php
- FieldManagerTest.php
- FieldNameCollisionExceptionTest.php
- FieldsBuilderCustomFieldKeysTest.php
- FieldsBuilderTest.php
- FlexibleContentBuilderTest.php
- GroupBuilderTest.php
- LocationBuilderTest.php
- ParentDelegationBuilderTest.php
- RepeaterBuilderTest.php
- TabBuilderTest.php
- test_autoload.php
- TestUtils.php
.gitignore
.scrutinizer.yml
.travis.yml
autoload.php
composer.json
composer.lock
gulpfile.js
LICENSE
package.json
phpunit.xml
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/StoutLogic/acf-builder

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd acf-builder

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. PHP (Composer)

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
PHP PHP 실행 환경이 필요합니다.
Composer PHP 라이브러리 설치를 위한 패키지 매니저입니다.

composer require stoutlogic/acf-builder

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ php -S localhost:8000 같은 내장 서버로 실행한 뒤 브라우저에서 http://localhost:8000 으로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ACF Builder

Create configuration arrays for [Advanced Custom Fields Pro](https://www.advancedcustomfields.com/pro/) using the builder pattern and a fluent API.

Quickly create, register, and reuse ACF configurations, and keep them in your source code repository. To read more about registering ACF fields via php consult https://www.advancedcustomfields.com/resources/register-fields-via-php/

[![Latest Stable Version](https://poser.pugx.org/stoutlogic/acf-builder/v/stable)](https://packagist.org/packages/stoutlogic/acf-builder)
[![Build Status](https://github.com/stoutlogic/acf-builder/workflows/TESTS/badge.svg)](https://github.com/StoutLogic/acf-builder/actions?query=workflow%3ATESTS)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/StoutLogic/acf-builder/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/StoutLogic/acf-builder/?branch=master)
[![Join the chat at https://gitter.im/StoutLogic/acf-builder](https://badges.gitter.im/StoutLogic/acf-builder.svg)](https://gitter.im/StoutLogic/acf-builder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

### Simple Example
```php
$banner = new StoutLogic\AcfBuilder\FieldsBuilder('banner');
$banner
    ->addText('title')
    ->addWysiwyg('content')
    ->addImage('background_image')
    ->setLocation('post_type', '==', 'page')
        ->or('post_type', '==', 'post');

add_action('acf/init', function() use ($banner) {
   acf_add_local_field_group($banner->build());
});
```

`$banner->build();` will return:
```php
[
    'key' => 'group_banner',
    'title' => 'Banner',
    'fields' => [
        [
            'key' => 'field_title',
            'name' => 'title',
            'label' => 'Title',
            'type' => 'text'
        ],
        [
            'key' => 'field_content',
            'name' => 'content',
            'label' => 'Content',
            'type' => 'wysiwyg'
        ],
        [
            'key' => 'field_background_image',
            'name' => 'background_image',
            'label' => 'Background Image',
            'type' => 'image'
        ],
    ],
    'location' => [
        [
            [
                'param' => 'post_type',
                'operator' => '==',
                'value' => 'page'
            ]
        ],
        [
            [
                'param' => 'post_type',
                'operator' => '==',
                'value' => 'post'
            ]
        ]
    ]
]
```

As you can see it saves you a lot of typing and is less error-prone. But brevity and correctness isn't the only benefit, you can reuse field configurations in multiple places. For example, a group of fields used for backgrounds:

### Reuse Example

```php

use StoutLogic\AcfBuilder\FieldsBuilder;

$background = new FieldsBuilder('background');
$background
    ->addTab('Background')
    ->addImage('background_image')
    ->addTrueFalse('fixed')
        ->instructions("Check to add a parallax effect where the background image doesn't move when scrolling")
    ->addColorPicker('background_color');

$banner = new FieldsBuilder('banner');
$banner
    ->addTab('Content')
    ->addText('title')
    ->addWysiwyg('content')
    ->addFields($background)
    ->setLocation('post_type', '==', 'page');

$section = new FieldsBuilder('section');
$section
    ->addTab('Content')
    ->addText('section_title')
    ->addRepeater('columns', ['min' => 1, 'layout' => 'block'])
        ->addTab('Content')
        ->addText('title')
        ->addWysiwyg('content')
        ->addFields($background)
        ->endRepeater()
    ->addFields($background)
    ->setLocation('post_type', '==', 'page');
```

Here a `background` field group is created, and then used in two other field groups, including twice in the `section` field group. This can really DRY up your code and keep your admin UI consistent. If you wanted to add a light/dark field for the text color field based on the background used, it would just need to be added in one spot and used everywhere.

## Install
Use composer to install:
```
composer require stoutlogic/acf-builder
```

If your project isn't using composer, you can require the `autoload.php` file.

## Tests
To run the tests you can manually run
```
vendor/bin/phpunit
```
or you can use the built in gulp task to run it on file change
```
npm install
gulp
```

## Requirements
PHP 5.4 through 7.2 supported but automated tests cannot be run anymore so it might stop working at some point.
>= 7.4, 8 Tested

## Documentation
See the [wiki](https://github.com/StoutLogic/acf-builder/wiki) for more thorough documentation. The documentation has its [own repository](https://github.com/StoutLogic/acf-builder-wiki) and accepts pull requests for contributions. Any merges to master will get synced with the wiki here under the main project.