Przejdź do treści

Migracja z ACF Blocks

Jeśli tworzysz własne bloki WordPress za pomocą ACF (Advanced Custom Fields), migracja do Blockstudio jest prosta. Koncepcje są podobne: definiujesz pola, piszesz szablon, a blok pojawia się w edytorze. Różnice polegają na tym, że Blockstudio samodzielnie wykrywa foldery bloków, definiuje pola we własnym schemacie w block.json i przekazuje każdemu szablonowi wartości pól jako jedną tablicę $a.

Ten przewodnik omawia migrację krok po kroku i porównuje obok siebie wzorce ACF oraz Blockstudio.

Główna różnica

Od wersji ACF 6.0 blok ACF jest obiektem block.json z kluczem acf wskazującym szablon renderowania, a każdy folder bloku rejestruje się osobnym wywołaniem register_block_type(). Pola pochodzą z grupy pól przypisanej do bloku regułą lokalizacji Block (utworzonej w panelu administracyjnym, synchronizowanej przez Local JSON lub zarejestrowanej za pomocą acf_add_local_field_group()) albo, od wersji ACF PRO 6.8.1, z tablicy acf.fields umieszczonej w tym samym block.json. Blockstudio zastępuje wywołanie rejestracji automatycznym wykrywaniem plików: utwórz folder z plikiem block.json i plikiem index.php, a blok zostanie zarejestrowany automatycznie.

ACF:

JSON
{
  "name": "acf/hero",
  "title": "Hero",
  "acf": {
    "renderTemplate": "template.php"
  }
}
PHP
add_action( 'init', function () {
  register_block_type( __DIR__ . '/blocks/hero' );
} );
PHP
acf_add_local_field_group([
  'key'      => 'group_hero',
  'title'    => 'Hero Fields',
  'fields'   => [
    ['key' => 'field_title', 'name' => 'title', 'type' => 'text', 'label' => 'Title'],
    ['key' => 'field_image', 'name' => 'image', 'type' => 'image', 'label' => 'Background', 'return_format' => 'array'],
  ],
  'location' => [[['param' => 'block', 'operator' => '==', 'value' => 'acf/hero']]],
]);
PHP
<?php
$title = get_field('title');
$image = get_field('image');
?>
<div class="hero" <?php if ($image) : ?>style="background-image: url(<?php echo esc_url($image['url']); ?>)"<?php endif; ?>>
  <h1><?php echo esc_html($title); ?></h1>
</div>

Blockstudio:

JSON
{
  "name": "my-theme/hero",
  "title": "Hero",
  "blockstudio": {
    "attributes": [
      { "id": "title", "type": "text", "label": "Title" },
      { "id": "image", "type": "files", "label": "Background", "multiple": false }
    ]
  }
}
PHP
<div useBlockProps class="hero" <?php if ($a['image']) : ?>style="background-image: url(<?php echo esc_url($a['image']['url']); ?>)"<?php endif; ?>>
  <h1><?php echo esc_html($a['title']); ?></h1>
</div>

Nie potrzeba wywołania rejestracji ani funkcji zwrotnej renderowania: strukturę folderów traktuje się jako rejestrację, a pola znajdują się w block.json obok szablonu. Szablon odczytuje $a zamiast wywoływać get_field().

Rejestrowanie bloków

ACF

Obecne bloki ACF rejestruje się z block.json zawierającego klucz acf (renderTemplate lub renderCallback oraz opcje takie jak blockVersion). Są ładowane przez jawne wywołanie register_block_type() dla każdego folderu bloku, zwykle w init w pliku functions.php lub pliku wtyczki. Starsze bloki mogą nadal używać acf_register_block_type(), które ACF oznacza jako przestarzałe od wersji ACF 6.0. Nadal działa, więc migruj takie bloki w ten sam sposób.

Blockstudio

Utwórz folder w katalogu blockstudio/ motywu (lub w blocks/, jeśli wolisz). Dodaj plik block.json ze standardowymi metadanymi bloku WordPress oraz kluczem blockstudio. To wszystko.

Kod
theme/
└── blockstudio/
    └── hero/
        ├── block.json
        └── index.php

block.json korzysta ze standardowego formatu WordPress block.json, a klucz blockstudio służy do definiowania pól i konfiguracji:

JSON
{
  "name": "my-theme/hero",
  "title": "Hero",
  "category": "theme",
  "icon": "cover-image",
  "description": "Full-width hero section with background image.",
  "blockstudio": {
    "attributes": []
  }
}

Dostęp do wartości pól

To najczęstsza zmiana, którą wprowadzisz podczas migracji.

ACF Blockstudio
get_field('title') $a['title']
get_field('title', $post_id) $a['title'] (zawsze dostępne)
the_field('title') <?php echo $a['title']; ?>
have_rows('items') / the_row() foreach ($a['items'] as $item)
get_sub_field('name') $item['name']

Zmienna $a to skrót $attributes zawierający wartości wszystkich pól bieżącego bloku. Jest zawsze dostępna w szablonie, zarówno w edytorze, jak i na frontendzie.

Zmienne szablonu

Blockstudio udostępnia w każdym szablonie kilka zmiennych:

Zmienna Skrót Opis
$attributes $a Wszystkie wartości pól
$block $b Metadane bloku (nazwa, tytuł, dir, url, postId)
$context $c Kontekst bloku nadrzędnego
$content Treść InnerBlocks
$post_id Bieżący identyfikator wpisu (działa w edytorze i na frontendzie; post_id lub postId w Twig)

Mapowanie typów pól

Większość typów pól ACF ma bezpośredni odpowiednik w Blockstudio. Składnia JSON jest inna, ale pojęcia można łatwo dopasować.

Pola tekstowe i treści

ACF:

PHP
['name' => 'title', 'type' => 'text', 'label' => 'Title', 'default_value' => 'Hello']
['name' => 'bio', 'type' => 'textarea', 'label' => 'Bio', 'rows' => 4]
['name' => 'content', 'type' => 'wysiwyg', 'label' => 'Content']

Blockstudio:

JSON
{ "id": "title", "type": "text", "label": "Title", "default": "Hello" }
{ "id": "bio", "type": "textarea", "label": "Bio", "rows": 4 }
{ "id": "content", "type": "wysiwyg", "label": "Content" }

Do edytowalnego tekstu w edytorze bloków (nie tylko pola tekstowego) użyj typu richtext z komponentem <RichText />:

JSON
{ "id": "heading", "type": "richtext" }
PHP
<RichText attribute="heading" tag="h1" placeholder="Enter heading" />

Pola obrazów i plików

Pola image i file w ACF odpowiadają typowi files w Blockstudio:

ACF:

PHP
['name' => 'photo', 'type' => 'image', 'return_format' => 'array']
['name' => 'gallery', 'type' => 'gallery', 'return_format' => 'array']
['name' => 'document', 'type' => 'file', 'return_format' => 'array']

Blockstudio:

JSON
{ "id": "photo", "type": "files", "label": "Photo", "multiple": false }
{ "id": "gallery", "type": "files", "label": "Gallery", "multiple": true }
{ "id": "document", "type": "files", "label": "Document", "multiple": false, "allowedTypes": ["application/pdf"] }

Struktura zwracanego obiektu jest podobna:

PHP
// ACF
$image = get_field('photo');
echo $image['url'];
echo $image['alt'];

// Blockstudio
echo $a['photo']['url'];
echo $a['photo']['alt'];

Dostępne właściwości: ID, title, alt, caption, description, href, url, sizes. Wymiary są podane w sizes, na przykład $a['photo']['sizes']['full-width'].

Lista wyboru, przyciski opcji i pola wyboru

ACF:

PHP
[
  'name' => 'color',
  'type' => 'select',
  'choices' => ['red' => 'Red', 'blue' => 'Blue'],
  'return_format' => 'value',
]

Blockstudio:

JSON
{
  "id": "color",
  "type": "select",
  "label": "Color",
  "options": [
    { "value": "red", "label": "Red" },
    { "value": "blue", "label": "Blue" }
  ]
}

Użyj "returnFormat": "both", aby pobrać zarówno wartość, jak i etykietę:

PHP
echo $a['color']['value'];  // "red"
echo $a['color']['label'];  // "Red"

Ten sam wzorzec dotyczy typów radio i checkbox.

Przełącznik i wartości logiczne

ACF:

PHP
['name' => 'show_cta', 'type' => 'true_false', 'label' => 'Show CTA']

Blockstudio:

JSON
{ "id": "showCta", "type": "toggle", "label": "Show CTA" }

ACF:

PHP
['name' => 'cta', 'type' => 'link', 'return_format' => 'array']

// Template
$link = get_field('cta');
echo $link['url'];
echo $link['title'];
echo $link['target'];

Blockstudio:

JSON
{ "id": "cta", "type": "link", "label": "CTA", "opensInNewTab": true }
PHP
echo $a['cta']['url'];
echo $a['cta']['title'];
echo $a['cta']['target'];

Kolor i gradient

ACF:

PHP
['name' => 'bgColor', 'type' => 'color_picker', 'label' => 'Background']

Blockstudio:

JSON
{ "id": "bgColor", "type": "color", "label": "Background" }
{ "id": "bgGradient", "type": "gradient", "label": "Background Gradient" }

Typ color integruje się z paletą kolorów WordPress. Typ gradient udostępnia selektor gradientu.

Liczby, zakresy i daty

ACF:

PHP
['name' => 'count', 'type' => 'number', 'min' => 1, 'max' => 10]
['name' => 'opacity', 'type' => 'range', 'min' => 0, 'max' => 100, 'step' => 5]
['name' => 'eventDate', 'type' => 'date_picker']

Blockstudio:

JSON
{ "id": "count", "type": "number", "label": "Count", "min": 1, "max": 10 }
{ "id": "opacity", "type": "range", "label": "Opacity", "min": 0, "max": 100, "step": 5 }
{ "id": "eventDate", "type": "date", "label": "Event Date" }

Pola powtarzalne

Pole powtarzalne w ACF odpowiada bezpośrednio typowi repeater w Blockstudio. Szablony ACF zazwyczaj iterują za pomocą have_rows() / the_row() / get_sub_field() (get_field() dla pola powtarzalnego również zwraca tablicę wierszy); Blockstudio udostępnia tylko zwykłą tablicę PHP, już w formacie $a.

ACF:

PHP
['name' => 'features', 'type' => 'repeater', 'sub_fields' => [
  ['name' => 'title', 'type' => 'text'],
  ['name' => 'description', 'type' => 'textarea'],
]]

// Template
if (have_rows('features')) :
  while (have_rows('features')) : the_row();
    echo get_sub_field('title');
    echo get_sub_field('description');
  endwhile;
endif;

Blockstudio:

JSON
{
  "id": "features",
  "type": "repeater",
  "label": "Features",
  "min": 1,
  "max": 10,
  "attributes": [
    { "id": "title", "type": "text", "label": "Title" },
    { "id": "description", "type": "textarea", "label": "Description" }
  ]
}
PHP
<?php foreach ($a['features'] as $feature) : ?>
  <h3><?php echo esc_html($feature['title']); ?></h3>
  <p><?php echo esc_html($feature['description']); ?></p>
<?php endforeach; ?>

Pola powtarzalne Blockstudio obsługują zagnieżdżanie do 3 poziomów (pole powtarzalne w polu powtarzalnym).

Grupy

Pole grupy w ACF odpowiada typowi group w Blockstudio. Identyfikatory pól w grupach otrzymują prefiks z identyfikatorem grupy.

ACF:

PHP
['name' => 'author', 'type' => 'group', 'sub_fields' => [
  ['name' => 'name', 'type' => 'text'],
  ['name' => 'role', 'type' => 'text'],
]]

// Template
$author = get_field('author');
echo $author['name'];
echo $author['role'];

Blockstudio:

JSON
{
  "id": "author",
  "type": "group",
  "title": "Author",
  "attributes": [
    { "id": "name", "type": "text", "label": "Name" },
    { "id": "role", "type": "text", "label": "Role" }
  ]
}
PHP
<?php $author = bs_get_group($a, 'author'); ?>
<p><?php echo esc_html($author['name']); ?></p>
<p><?php echo esc_html($author['role']); ?></p>

Pomocnik bs_get_group() usuwa prefiks grupy z identyfikatorów pól, zapewniając do nich bezpośredni dostęp. Bez niego pola byłyby dostępne jako $a['author_name'] i $a['author_role'].

Logika warunkowa

Zarówno ACF, jak i Blockstudio obsługują logikę warunkową, która pozwala pokazywać i ukrywać pola w zależności od wartości innych pól.

ACF:

PHP
['name' => 'showSubtitle', 'type' => 'true_false'],
[
  'name' => 'subtitle',
  'type' => 'text',
  'conditional_logic' => [[['field' => 'field_showSubtitle', 'operator' => '==', 'value' => '1']]]
]

Blockstudio:

JSON
{ "id": "showSubtitle", "type": "toggle", "label": "Show Subtitle" },
{
  "id": "subtitle",
  "type": "text",
  "label": "Subtitle",
  "conditions": [[{ "id": "showSubtitle", "operator": "==", "value": true }]]
}

Warunki Blockstudio bezpośrednio odwołują się do identyfikatorów pól (nie ich kluczy). Dostępne operatory: ==, !=, includes, !includes, empty, !empty, <, >, <=, >=.

Blockstudio obsługuje również warunki globalne oparte na typie wpisu, jego identyfikatorze, roli użytkownika i identyfikatorze użytkownika:

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

InnerBlocks

Zarówno ACF, jak i Blockstudio obsługują InnerBlocks, które pozwalają zagnieżdżać inne bloki we własnym bloku, z tym samym znacznikiem <InnerBlocks /> oraz tymi samymi atrybutami allowedBlocks, template i templateLock, więc ta część szablonu zwykle nie wymaga zmian.

Blockstudio:

PHP
<div useBlockProps class="my-wrapper">
  <InnerBlocks
    allowedBlocks='<?php echo esc_attr(wp_json_encode(["core/heading", "core/paragraph", "core/image"])); ?>'
    template='<?php echo esc_attr(wp_json_encode([
      ["core/heading", ["placeholder" => "Section title"]],
      ["core/paragraph", ["placeholder" => "Section content"]]
    ])); ?>'
    templateLock="insert"
  />
</div>

Znacznik <InnerBlocks /> zastępuje komponent React w edytorze, a na frontendzie — wyrenderowana treść bloku.

Przechowywanie metadanych wpisu

Zarówno ACF Blocks, jak i Blockstudio domyślnie zapisują wartości pól jako atrybuty bloków w treści wpisu, a nie w metadanych wpisu. Oznacza to, że wartości pól nie można wyszukiwać za pomocą WP_Query, chyba że włączysz zapisywanie w metadanych.

ACF dodał opcjonalne zapisywanie bloków w metadanych wpisu w ACF PRO 6.3 za pomocą usePostMeta: true — dla jednego bloku najwyższego poziomu na stronę. Blockstudio umożliwia włączenie tej opcji dla każdego pola za pomocą właściwości storage:

JSON
{
  "id": "featured",
  "type": "toggle",
  "label": "Featured",
  "storage": {
    "type": "postMeta",
    "postMetaKey": "is_featured"
  }
}

Klucz metadanych jest automatycznie rejestrowany przez show_in_rest. Możesz uzyskać do niego dostęp w dowolnym miejscu za pomocą get_post_meta($post_id, 'is_featured', true).

W przypadku wartości dostępnych w całej witrynie (takich jak strony opcji ACF) użyj zapisu w opcjach:

JSON
{
  "storage": {
    "type": "option",
    "optionKey": "site_company_name"
  }
}

Rozszerzanie istniejących bloków

ACF’s reguła lokalizacji bloków przypisuje grupy pól wyłącznie do bloków ACF; nie dodaje pól do bloków podstawowych ani bloków firm trzecich. W przypadku bloków podstawowych, takich jak Nagłówek, Akapit, Obraz i Przycisk, ACF’s rozwiązaniem są WordPress Block Bindings API, które łączą istniejące atrybuty bloków z wartościami pól ACF. Blockstudio może dodawać nowe pola i kontrolki do dowolnego zarejestrowanego bloku za pomocą plików rozszerzeń.

Utwórz plik rozszerzenia w katalogu blockstudio:

JSON
{
  "name": "core/heading",
  "blockstudio": {
    "extend": true,
    "attributes": [
      {
        "id": "accentColor",
        "type": "color",
        "label": "Accent Color",
        "set": [{ "attribute": "style", "value": "color: {attributes.accentColor}" }]
      }
    ]
  }
}

Właściwość set automatycznie przypisuje wartość pola do HTML bloku. Użyj symboli wieloznacznych, aby rozszerzyć wiele bloków naraz: "name": "core/*".

Lista kontrolna migracji

  1. Utwórz folder bloku w theme/blockstudio/{block-name}/, zawierający block.json i index.php.
  2. Przenieś definicje pól z grupy pól bloku (Local JSON, acf_add_local_field_group() lub tablicy acf.fields wpisanej bezpośrednio w kodzie) do tablicy blockstudio.attributes w block.json. Zmień name na id, usuń key i w razie potrzeby dostosuj nazwy typów.
  3. Zaktualizuj dostęp w szablonie z get_field('name') na $a['name']. Zastąp pętle have_rows() przez foreach ($a['repeater'] as $item).
  4. Zastąp get_sub_field() bezpośrednim dostępem do tablicy: $item['fieldId'].
  5. Dodaj useBlockProps do najbardziej zewnętrznego elementu w szablonie, aby zapewnić prawidłową integrację z edytorem.
  6. Przenieś logikę warunkową z conditional_logic w ACF do conditions w Blockstudio, odwołując się do identyfikatorów pól zamiast ich kluczy.
  7. Dodaj zapis dla pól, których wartości były wcześniej wyszukiwane przez get_post_meta() lub używane w WP_Query.
  8. Usuń kod rejestrujący ACF: wywołania register_block_type() i klucze acf zmigrowanych bloków (lub ich wywołania acf_register_block_type()) oraz ich grupy pól, niezależnie od tego, czy znajdują się w Local JSON, acf_add_local_field_group(), tablicy acf.fields wpisanej bezpośrednio w kodzie czy panelu administracyjnym.
  9. Przetestuj w edytorze, aby sprawdzić, czy pola wyświetlają się prawidłowo, a następnie sprawdź wynik na stronie.