본문으로 건너뛰기

등록

Blockstudio을 사용해 블록을 직접 구성하는 일은 매우 쉽습니다. 플러그인은 현재 활성화된 테마 안에서 blockstudio 폴더를 찾습니다. 이 폴더에서 block.json 파일과 blockstudio 키가 포함된 모든 하위 폴더가 등록됩니다.

block.json

JSON
{
  "name": "blockstudio/native",
  "title": "Native Block",
  "category": "text",
  "icon": "star-filled",
  "description": "Native Blockstudio block.",
  "blockstudio": true
}

템플릿

현재 사용자 정의 블록에는 템플릿이 없어 등록되지 않습니다. 해결하려면 block.json 파일과 같은 폴더에 index.php을 만들면 됩니다. 그러면 블록을 사용할 때 해당 내용이 자동으로 렌더링됩니다.

PHP
<h1>My first native block.</h1>

조건부 로직

conditions 키를 사용해 블록을 조건부로 등록할 수 있습니다. 이 키는 속성에서 사용할 수 있는 모든 전역 변수를 지원합니다.

모든 조건 보기

다음 예제에서는 현재 글 유형이 페이지인 경우에만 블록이 등록됩니다:

JSON
{
  "blockstudio": {
    "conditions": [
      [
        {
          "type": "postType",
          "operator": "==",
          "value": "page"
        }
      ]
    ]
  }
}

플러그인 종속성

WordPress 플러그인이 활성화되어 있어야 하는 블록은 pluginDependencies 키를 사용해 종속성을 지정할 수 있습니다. 목록에 있는 플러그인 중 하나라도 비활성 상태이면 등록 중에 해당 블록을 건너뜁니다.

종속성에는 WordPress 플러그인 슬러그를 사용합니다:

JSON
{
  "blockstudio": {
    "pluginDependencies": [
      "woocommerce",
      "advanced-custom-fields"
    ]
  }
}

객체 형식을 사용하면 플러그인 버전을 지정할 수 있습니다. 버전 제약 조건에는 PHP의 version_compare()과 같은 연산자를 사용합니다. 연산자가 없는 버전은 >=로 처리됩니다.

JSON
{
  "blockstudio": {
    "pluginDependencies": {
      "woocommerce": {
        "version": ">6"
      }
    }
  }
}

사용자 정의 아이콘

블록용 사용자 정의 SVG 아이콘은 다음과 같이 등록할 수 있습니다:

JSON
{
  "blockstudio": {
    "icon": "<svg></svg>"
  }
}

WordPress은 자체 block.json icon 키 안에 사용자 정의 SVG 아이콘을 허용하지 않습니다. 여기서는 Dashicons ID만 허용됩니다.

표준 WordPress 블록

Blockstudio은 Blockstudio 디렉터리에서 찾은 표준 WordPress 블록도 자동 등록합니다. blockstudio 키는 없지만 유효한 name 속성이 있는 block.json은 WordPress의 기본 register_block_type()을 통해 등록됩니다.

즉, @wordpress/create-block으로 스캐폴딩한 블록을 blockstudio/ 폴더에 바로 넣으면 Blockstudio 블록과 함께 자동으로 등록됩니다. 별도의 플러그인 등록 코드가 필요하지 않습니다.

코드
blockstudio/
├── hero/
│   ├── block.json          ← Blockstudio block (has "blockstudio" key)
│   └── index.twig
├── my-js-block/
│   ├── block.json          ← Standard WP block (no "blockstudio" key)
│   ├── index.js            ← Compiled editor script
│   ├── index.css
│   ├── style-index.css
│   └── render.php

npx wp-scripts build으로 블록을 빌드한 다음 출력 폴더를 Blockstudio 디렉터리에 넣으세요. 자동으로 등록됩니다.

WordPress 7.0의 PHP 전용 블록에도 동일하게 적용됩니다: autoRegister 지원이 포함된 block.json와 render.php만 있으면 스크립트나 빌드 없이 다른 표준 블록처럼 등록됩니다. 코어는 이 경로를 문자열, 정수, 불리언 및 열거형 속성을 사용하는 단순 블록으로 제한합니다. 내부 블록, 서식 있는 텍스트, 미디어 또는 사용자 정의 컨트롤이 필요한 순간에는 클라이언트 측 블록을 스캐폴딩하거나 blockstudio 키를 지정해 PHP에 머무르세요.

HTML

Blockstudio은 React 요소 파서를 사용해 아이콘 요소를 렌더링하므로 아이콘 문자열 안에서 HTML을 사용할 수 있습니다.

JSON
{
  "blockstudio": {
    "icon": "<div>:-)</div>"
  }
}

사용자 정의 경로

기본적으로 Blockstudio은 현재 테마 또는 하위 테마의 blockstudio 폴더를 재귀적으로 검색해 블록을 찾습니다. 이 동작은 두 가지 방법으로 변경할 수 있습니다.

필터

PHP
// Custom path within your theme.
add_filter('blockstudio/path', function () {
    return get_template_directory() . '/blocks';
});

// Custom path within a plugin.
add_filter('blockstudio/path', function () {
    return WP_PLUGIN_DIR . '/my-custom-plugin/blocks';
});

구성된 파일 시스템이나 가상 파일 시스템에서는 독립적인 상위 경로와 오버레이 경로를 추가하는 대신 논리적 검색 소스를 사용하세요. 논리적 소스는 경로별 가리기, 상속된 형제 파일, 삭제, 캐시 식별 및 출처 추적을 지원합니다. 논리적 검색 소스를 참조하세요.

인스턴스

위 옵션으로 충분하지 않다면 원하는 여러 폴더에서 Blockstudio\Build 클래스를 초기화할 수 있습니다:

PHP
add_action('init', function () {
  Blockstudio\Build::init([
    'dir' => get_template_directory() . '/client-blocks'
  ]);
});

메타데이터 필터링

블록을 등록하기 전에 blockstudio/blocks/meta 필터를 사용해 메타데이터를 필터링할 수 있습니다:

PHP
add_filter('blockstudio/blocks/meta', function ($meta, $block) {
    if (str_starts_with($block['name'], 'marketing')) {
        $meta['icon'] = 'megaphone';
    }
    return $meta;
}, 10, 2);

위 예제는 모든 Blockstudio 라이브러리 요소에 동일한 아이콘을 지정하기 위해 내부적으로 사용됩니다.