Migrace z ACF Blocks
Pokud jste vytvářeli vlastní bloky WordPress pomocí ACF (Advanced Custom Fields), přechod na Blockstudio je přímočarý. Koncepty jsou podobné: definujete pole, napíšete šablonu a blok se objeví v editoru. Rozdíl je v tom, že Blockstudio samo vyhledává složky bloků, deklaruje pole ve vlastním schématu uvnitř block.json a předává každé šabloně jejich hodnoty jako jedno pole $a.
Tento průvodce vás provede migrací krok za krokem a nabídne srovnání vzorů pro ACF a Blockstudio vedle sebe.
Hlavní rozdíl
Od verze ACF 6.0 je blok ACF objektem block.json s klíčem acf, který určuje jeho vykreslovací šablonu. Každá složka bloku se registruje vlastním voláním register_block_type(). Pole pocházejí ze skupiny polí připojené k bloku pravidlem umístění Block (vytvořené v administraci, synchronizované přes Local JSON nebo registrované pomocí acf_add_local_field_group()), případně od verze ACF PRO 6.8.1 z vloženého pole acf.fields ve stejném block.json. Blockstudio nahrazuje registrační volání automatickým vyhledáváním souborů: vytvořte složku se soubory block.json a index.php a blok se zaregistruje automaticky.
ACF:
{
"name": "acf/hero",
"title": "Hero",
"acf": {
"renderTemplate": "template.php"
}
}
add_action( 'init', function () {
register_block_type( __DIR__ . '/blocks/hero' );
} );
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
$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:
{
"name": "my-theme/hero",
"title": "Hero",
"blockstudio": {
"attributes": [
{ "id": "title", "type": "text", "label": "Title" },
{ "id": "image", "type": "files", "label": "Background", "multiple": false }
]
}
}
<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>
Není potřeba registrační volání ani zpětné volání pro vykreslení: registraci zajišťuje struktura složek a pole jsou v block.json vedle šablony. Šablona čte $a místo volání get_field().
Registrace bloku
ACF
Stávající bloky ACF se registrují z block.json s klíčem acf (renderTemplate nebo renderCallback, plus možnosti jako blockVersion). Načítají se explicitním voláním register_block_type() pro každou složku bloku, obvykle na init v souboru functions.php nebo v souboru pluginu. Starší bloky mohou stále používat acf_register_block_type(), které ACF označuje za zastaralé od verze ACF 6.0. Nadále funguje, proto tyto bloky převeďte stejným způsobem.
Blockstudio
Vytvořte složku v adresáři blockstudio/ své šablony (nebo v blocks/, pokud vám to vyhovuje více). Přidejte soubor block.json se standardními metadaty bloku WordPress a klíčem blockstudio. To je vše.
theme/
└── blockstudio/
└── hero/
├── block.json
└── index.php
block.json používá standardní formát WordPress block.json s klíčem blockstudio pro pole a konfiguraci:
{
"name": "my-theme/hero",
"title": "Hero",
"category": "theme",
"icon": "cover-image",
"description": "Full-width hero section with background image.",
"blockstudio": {
"attributes": []
}
}
Přístup k hodnotám polí
Toto je nejběžnější změna, kterou při migraci provedete.
| ACF | Blockstudio |
|---|---|
get_field('title') |
$a['title'] |
get_field('title', $post_id) |
$a['title'] (vždy dostupné) |
the_field('title') |
<?php echo $a['title']; ?> |
have_rows('items') / the_row() |
foreach ($a['items'] as $item) |
get_sub_field('name') |
$item['name'] |
Proměnná $a je zkráceným zápisem pro $attributes a obsahuje všechny hodnoty polí aktuálního bloku. V šabloně je vždy dostupná, v editoru i na frontendu.
Proměnné šablony
Blockstudio poskytuje v každé šabloně několik proměnných:
| Proměnná | Zkrácený zápis | Popis |
|---|---|---|
$attributes |
$a |
Všechny hodnoty polí |
$block |
$b |
Metadata bloku (název, titulek, dir, url, postId) |
$context |
$c |
Kontext nadřazeného bloku |
$content |
Obsah InnerBlocks | |
$post_id |
ID aktuálního příspěvku (funguje v editoru i na frontendu; post_id nebo postId v Twig) |
Mapování typů polí
Většina typů polí ACF má přímý ekvivalent v Blockstudio. Syntaxe JSON se liší, ale koncepty lze snadno propojit.
Textová a obsahová pole
ACF:
['name' => 'title', 'type' => 'text', 'label' => 'Title', 'default_value' => 'Hello']
['name' => 'bio', 'type' => 'textarea', 'label' => 'Bio', 'rows' => 4]
['name' => 'content', 'type' => 'wysiwyg', 'label' => 'Content']
Blockstudio:
{ "id": "title", "type": "text", "label": "Title", "default": "Hello" }
{ "id": "bio", "type": "textarea", "label": "Bio", "rows": 4 }
{ "id": "content", "type": "wysiwyg", "label": "Content" }
Pro upravitelný text v editoru bloků (nejen textový vstup) použijte typ richtext s komponentou <RichText />:
{ "id": "heading", "type": "richtext" }
<RichText attribute="heading" tag="h1" placeholder="Enter heading" />
Pole obrázků a souborů
Pole image a file v ACF odpovídají typu files v Blockstudio:
ACF:
['name' => 'photo', 'type' => 'image', 'return_format' => 'array']
['name' => 'gallery', 'type' => 'gallery', 'return_format' => 'array']
['name' => 'document', 'type' => 'file', 'return_format' => 'array']
Blockstudio:
{ "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 vráceného objektu je podobná:
// ACF
$image = get_field('photo');
echo $image['url'];
echo $image['alt'];
// Blockstudio
echo $a['photo']['url'];
echo $a['photo']['alt'];
Dostupné vlastnosti: ID, title, alt, caption, description, href, url, sizes. Rozměry jsou uvedeny v sizes, například $a['photo']['sizes']['full-width'].
Výběr, přepínače a zaškrtávací políčka
ACF:
[
'name' => 'color',
'type' => 'select',
'choices' => ['red' => 'Red', 'blue' => 'Blue'],
'return_format' => 'value',
]
Blockstudio:
{
"id": "color",
"type": "select",
"label": "Color",
"options": [
{ "value": "red", "label": "Red" },
{ "value": "blue", "label": "Blue" }
]
}
Pro získání hodnoty i popisku použijte "returnFormat": "both":
echo $a['color']['value']; // "red"
echo $a['color']['label']; // "Red"
Stejný vzor platí pro typy radio a checkbox.
Přepínač a hodnota true/false
ACF:
['name' => 'show_cta', 'type' => 'true_false', 'label' => 'Show CTA']
Blockstudio:
{ "id": "showCta", "type": "toggle", "label": "Show CTA" }
Pole odkazu
ACF:
['name' => 'cta', 'type' => 'link', 'return_format' => 'array']
// Template
$link = get_field('cta');
echo $link['url'];
echo $link['title'];
echo $link['target'];
Blockstudio:
{ "id": "cta", "type": "link", "label": "CTA", "opensInNewTab": true }
echo $a['cta']['url'];
echo $a['cta']['title'];
echo $a['cta']['target'];
Barva a přechod
ACF:
['name' => 'bgColor', 'type' => 'color_picker', 'label' => 'Background']
Blockstudio:
{ "id": "bgColor", "type": "color", "label": "Background" }
{ "id": "bgGradient", "type": "gradient", "label": "Background Gradient" }
Typ color je propojen s paletou barev WordPress. Typ gradient nabízí výběr přechodu.
Číslo, rozsah a datum
ACF:
['name' => 'count', 'type' => 'number', 'min' => 1, 'max' => 10]
['name' => 'opacity', 'type' => 'range', 'min' => 0, 'max' => 100, 'step' => 5]
['name' => 'eventDate', 'type' => 'date_picker']
Blockstudio:
{ "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" }
Opakovací pole
Opakovací pole ACF přímo odpovídá typu repeater v Blockstudio. Šablony ACF obvykle procházejí položky pomocí have_rows() / the_row() / get_sub_field() (get_field() u opakovacího pole vrací také pole řádků); Blockstudio má pouze prosté pole PHP, které už je ve formátu $a.
ACF:
['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:
{
"id": "features",
"type": "repeater",
"label": "Features",
"min": 1,
"max": 10,
"attributes": [
{ "id": "title", "type": "text", "label": "Title" },
{ "id": "description", "type": "textarea", "label": "Description" }
]
}
<?php foreach ($a['features'] as $feature) : ?>
<h3><?php echo esc_html($feature['title']); ?></h3>
<p><?php echo esc_html($feature['description']); ?></p>
<?php endforeach; ?>
Opakovací pole Blockstudio podporují vnořování (opakovací pole uvnitř opakovacího pole) až do 3 úrovní.
Skupiny
Skupinové pole ACF odpovídá typu group v Blockstudio. ID polí uvnitř skupin mají jako předponu ID skupiny.
ACF:
['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:
{
"id": "author",
"type": "group",
"title": "Author",
"attributes": [
{ "id": "name", "type": "text", "label": "Name" },
{ "id": "role", "type": "text", "label": "Role" }
]
}
<?php $author = bs_get_group($a, 'author'); ?>
<p><?php echo esc_html($author['name']); ?></p>
<p><?php echo esc_html($author['role']); ?></p>
Pomocná funkce bs_get_group() odstraňuje z ID polí předponu skupiny, takže k nim lze přistupovat jednoduše. Bez ní byste k polím přistupovali jako k $a['author_name'] a $a['author_role'].
Podmíněná logika
ACF i Blockstudio podporují podmíněnou logiku pro zobrazování a skrývání polí podle hodnot jiných polí.
ACF:
['name' => 'showSubtitle', 'type' => 'true_false'],
[
'name' => 'subtitle',
'type' => 'text',
'conditional_logic' => [[['field' => 'field_showSubtitle', 'operator' => '==', 'value' => '1']]]
]
Blockstudio:
{ "id": "showSubtitle", "type": "toggle", "label": "Show Subtitle" },
{
"id": "subtitle",
"type": "text",
"label": "Subtitle",
"conditions": [[{ "id": "showSubtitle", "operator": "==", "value": true }]]
}
Podmínky Blockstudio odkazují přímo na ID polí, nikoli na jejich klíče. Dostupné operátory: ==, !=, includes, !includes, empty, !empty, <, >, <=, >=.
Blockstudio podporuje také globální podmínky založené na typu příspěvku, ID příspěvku, uživatelské roli a ID uživatele:
{
"conditions": [[{ "type": "postType", "operator": "==", "value": "page" }]]
}
InnerBlocks
ACF i Blockstudio podporují InnerBlocks pro vnořování dalších bloků do vlastního bloku. Používají stejnou značku <InnerBlocks /> a stejné atributy allowedBlocks, template a templateLock, takže tuto část šablony obvykle není nutné měnit.
Blockstudio:
<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>
Značku <InnerBlocks /> v editoru nahrazuje komponenta React a na frontendu vykreslený obsah bloku.
Ukládání metadat příspěvku
ACF Blocks i Blockstudio ve výchozím nastavení ukládají hodnoty polí jako atributy bloku v obsahu příspěvku, nikoli do metadat příspěvku. To znamená, že hodnoty polí nelze dotazovat pomocí WP_Query, pokud nezvolíte ukládání do metadat.
ACF přidal v ACF PRO 6.3 možnost ukládání bloků do metadat příspěvku, kterou lze zapnout pomocí usePostMeta: true, a to pro jeden blok nejvyšší úrovně na stránku. Blockstudio nabízí možnost zapnout ukládání pro jednotlivá pole pomocí vlastnosti storage:
{
"id": "featured",
"type": "toggle",
"label": "Featured",
"storage": {
"type": "postMeta",
"postMetaKey": "is_featured"
}
}
Klíč metadat se automaticky zaregistruje pomocí show_in_rest. Přístup k němu získáte odkudkoli pomocí get_post_meta($post_id, 'is_featured', true).
Pro hodnoty platné pro celý web (například stránky s nastavením ACF) použijte ukládání do možností:
{
"storage": {
"type": "option",
"optionKey": "site_company_name"
}
}
Rozšíření stávajících bloků
Pravidlo umístění bloků v ACF připojuje skupiny polí pouze k blokům ACF; pole nepřidává do základních ani bloků třetích stran. Pro základní bloky, jako jsou Nadpis, Odstavec, Obrázek a Tlačítko, nabízí ACF rozhraní WordPress Block Bindings API, které propojuje existující atributy bloků s hodnotami polí v ACF. Blockstudio může přidávat nová pole a ovládací prvky do libovolného registrovaného bloku prostřednictvím rozšiřujících souborů.
Vytvořte rozšiřující soubor ve svém adresáři blockstudio:
{
"name": "core/heading",
"blockstudio": {
"extend": true,
"attributes": [
{
"id": "accentColor",
"type": "color",
"label": "Accent Color",
"set": [{ "attribute": "style", "value": "color: {attributes.accentColor}" }]
}
]
}
}
Vlastnost set automaticky přiřadí hodnotu pole vlastnosti bloku HTML. Pomocí zástupných znaků můžete rozšířit více bloků najednou: "name": "core/*".
Kontrolní seznam migrace
- Vytvořte složku bloku v
theme/blockstudio/{block-name}/pomocíblock.jsonaindex.php. - Přesuňte definice polí ze skupiny polí bloku (Local JSON,
acf_add_local_field_group()nebo vloženého poleacf.fields) do poleblockstudio.attributesvblock.json. Změňtenamenaid, odstraňtekeya podle potřeby upravte názvy typů. - Aktualizujte přístup v šabloně z
get_field('name')na$a['name']. Smyčkyhave_rows()nahraďte zaforeach ($a['repeater'] as $item). - Nahraďte
get_sub_field()přímým přístupem k poli:$item['fieldId']. - Přidejte
useBlockPropsdo nejvnějšího prvku šablony, aby byla správně integrována s editorem. - Přesuňte podmíněnou logiku z ACF
conditional_logicdo Blockstudioconditionsa odkazujte na ID polí místo jejich klíčů. - Přidejte ukládání pro všechna pole, která se dříve dotazovala přes
get_post_meta()nebo se používala vWP_Query. - Odstraňte registrační kód ACF: volání
register_block_type()a klíčeacfmigrovaných bloků (nebo jejich voláníacf_register_block_type()) a jejich skupiny polí, ať už jsou v Local JSON,acf_add_local_field_group(), vloženém poliacf.fieldsnebo v administraci. - Otestujte vše v editoru, ověřte, že se pole zobrazují správně, a pak zkontrolujte výstup na webu.