Hoppa till innehåll

Migrera från ACF Blocks

Om du har byggt anpassade WordPress-block med ACF (Advanced Custom Fields) är det enkelt att migrera till Blockstudio. Begreppen liknar varandra: du definierar fält, skriver en mall och blocket visas i redigeraren. Skillnaderna är att Blockstudio själv hittar blockmappar, deklarerar fält i sitt eget schema i block.json och ger varje mall fältvärdena som en enda $a-array.

Den här guiden går igenom migreringen steg för steg, med jämförelser sida vid sida av mönster för ACF och Blockstudio.

Den grundläggande skillnaden

Sedan ACF 6.0 är ett ACF-block ett block.json med en acf-nyckel som anger dess renderingsmall, och varje blockmapp registreras med ett eget anrop till register_block_type(). Fälten kommer från en fältgrupp som kopplats till blocket med en platsregel för block (skapad i adminpanelen, synkroniserad via Local JSON eller registrerad med acf_add_local_field_group()), eller, sedan ACF PRO 6.8.1, från en infogad acf.fields-array i samma block.json. Blockstudio ersätter registreringsanropet med automatisk filbaserad identifiering: skapa en mapp med en block.json och en index.php, så registreras blocket automatiskt.

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>

Inget registreringsanrop och ingen återanropsfunktion för återgivning: mappstrukturen är registreringen, och fälten finns i block.json bredvid mallen. Mallen läser $a i stället för att anropa get_field().

Blockregistrering

ACF

Nuvarande ACF-block registreras från en block.json med en acf-nyckel (renderTemplate eller renderCallback, plus alternativ som blockVersion), som läses in med ett uttryckligt anrop till register_block_type() för varje blockmapp, vanligtvis på init i functions.php eller i en tilläggsfil. Äldre block kan fortfarande använda acf_register_block_type(), som ACF har dokumenterat som föråldrat sedan ACF 6.0; det fungerar fortfarande, så migrera sådana block på samma sätt.

Blockstudio

Skapa en mapp i katalogen blockstudio/ för ditt tema (eller blocks/ om du föredrar det). Lägg till en block.json med standardmetadata för WordPress-block och en blockstudio-nyckel. Klart.

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

block.json använder standardformatet WordPress block.json med nyckeln blockstudio för fält och konfiguration:

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

Åtkomst till fältvärden

Det här är den vanligaste ändringen du gör under migreringen.

ACF Blockstudio
get_field('title') $a['title']
get_field('title', $post_id) $a['title'] (alltid tillgängligt)
the_field('title') <?php echo $a['title']; ?>
have_rows('items') / the_row() foreach ($a['items'] as $item)
get_sub_field('name') $item['name']

Variabeln $a är en förkortning för $attributes och innehåller alla fältvärden för det aktuella blocket. Den är alltid tillgänglig i mallen, både i redigeraren och på frontend.

Mallvariabler

Blockstudio tillhandahåller flera variabler i varje mall:

Variabel Förkortning Beskrivning
$attributes $a Alla fältvärden
$block $b Blockmetadata (name, title, dir, url, postId)
$context $c Kontext för överordnat block
$content InnerBlocks-innehåll
$post_id Aktuellt inläggs-ID (fungerar i redigeraren och på frontend; post_id eller postId i Twig)

Mappning av fälttyper

De flesta fälttyper i ACF har en direkt motsvarighet i Blockstudio. Syntaxen i JSON skiljer sig, men begreppen passar väl ihop.

Text- och innehållsfält

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" }

För redigerbar text i blockredigeraren (inte bara ett textfält) använder du typen richtext med komponenten <RichText />:

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

Bild- och filfält

Fälten image och file i ACF motsvarar typen files i 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"] }

Strukturen för det returnerade objektet liknar den tidigare:

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

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

Tillgängliga egenskaper: ID, title, alt, caption, description, href, url, sizes. Måtten anges i sizes, till exempel $a['photo']['sizes']['full-width'].

Väljare, alternativknappar och kryssrutor

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" }
  ]
}

Använd "returnFormat": "both" för att hämta både värde och etikett:

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

Samma mönster gäller för typerna radio och checkbox.

Växling och sant/falskt

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'];

Färg och 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" }

Typen color integreras med färgpaletten WordPress. Typen gradient tillhandahåller en gradientväljare.

Tal, intervall och datum

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" }

Upprepningsfält

Upprepningsfältet i ACF motsvarar direkt typen repeater i Blockstudio. Mallar för ACF loopar vanligtvis med have_rows() / the_row() / get_sub_field() (get_field() på ett upprepningsfält returnerar också en array med rader); Blockstudio har bara den vanliga PHP-arrayen, redan i $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; ?>

Upprepningsfält i Blockstudio stöder nästling (upprepningsfält inuti upprepningsfält) upp till 3 nivåer.

Grupper

Gruppfältet i ACF motsvarar typen group i Blockstudio. Fält-ID:n inuti grupper får grupp-ID:t som prefix.

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>

Hjälpfunktionen bs_get_group() tar bort prefixet från fält-ID:n, så att du får enkel åtkomst. Utan den skulle du komma åt fält som $a['author_name'] och $a['author_role'].

Villkorslogik

Både ACF och Blockstudio stöder villkorslogik för att visa och dölja fält utifrån andra fältvärden.

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 }]]
}

Villkor i Blockstudio hänvisar direkt till fält-ID:n (inte fältnycklar). Tillgängliga operatorer: ==, !=, includes, !includes, empty, !empty, <, >, <=, >=.

Blockstudio stöder även globala villkor baserade på inläggstyp, inläggs-ID, användarroll och användar-ID:

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

InnerBlocks

Både ACF och Blockstudio stöder InnerBlocks för att nästla andra block i ditt anpassade block, med samma <InnerBlocks />-tagg och samma attribut allowedBlocks, template och templateLock, så den här delen av en mall brukar kunna överföras oförändrad.

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>

Taggen <InnerBlocks /> ersätts med komponenten React i redigeraren och med det återgivna blockinnehållet på frontend.

Lagring av inläggsmetadata

Både ACF Blocks och Blockstudio lagrar fältvärden som blockattribut i inläggets innehåll som standard, inte i inläggsmetadata. Det innebär att fältvärden inte kan användas i sökningar med WP_Query om du inte väljer att lagra dem i metadata.

ACF lade till valfri lagring i inläggsmetadata för block i ACF PRO 6.3 via usePostMeta: true, för ett block på högsta nivå per sida. Blockstudio har en valfri mekanism per fält, med egenskapen storage:

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

Metanyckeln registreras automatiskt med show_in_rest. Du kan komma åt den var som helst med get_post_meta($post_id, 'is_featured', true).

För värden som gäller hela webbplatsen (som ACF-alternativsidor) använder du alternativlagring:

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

Utöka befintliga block

ACFs placeringsregel för block kopplar bara fältgrupper till ACF-block; den lägger inte till fält i kärnblock eller block från tredje part. ACFs väg till kärnblock som Heading, Paragraph, Image och Button är WordPress Block Bindings API, som kopplar befintliga blockattribut till ACF-fältvärden. Blockstudio kan lägga till nya fält och kontroller i alla registrerade block via tilläggsfiler.

Skapa en tilläggsfil i din blockstudio-katalog:

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

Egenskapen set tillämpar automatiskt fältvärdet på blockets HTML. Använd jokertecken för att utöka flera block samtidigt: "name": "core/*".

Checklista för migrering

  1. Skapa blockmappen i theme/blockstudio/{block-name}/ med block.json och index.php.
  2. Flytta fältdefinitionerna från blockets fältgrupp (Local JSON, acf_add_local_field_group() eller en inline-acf.fields-array) till arrayen blockstudio.attributes i block.json. Ändra name till id, ta bort key och justera typnamnen vid behov.
  3. Uppdatera åtkomsten i mallen från get_field('name') till $a['name']. Ersätt loopar med have_rows() med foreach ($a['repeater'] as $item).
  4. Ersätt get_sub_field() med direkt arrayåtkomst: $item['fieldId'].
  5. Lägg till useBlockProps i det yttersta elementet i mallen för korrekt integration med redigeraren.
  6. Flytta villkorslogik från ACFs conditional_logic till Blockstudios conditions och använd fält-ID:n i stället för fältnycklar.
  7. Lägg till lagring för alla fält som tidigare användes i sökningar via get_post_meta() eller användes i WP_Query.
  8. Ta bort ACF-registreringskoden: anropen till register_block_type() och nycklarna acf för de migrerade blocken (eller deras acf_register_block_type()-anrop), samt deras fältgrupper, oavsett om de finns i Local JSON, acf_add_local_field_group(), en inline-acf.fields-array eller adminpanelen.
  9. Testa i redigeraren för att kontrollera att fälten visas korrekt och granska sedan resultatet på webbplatsens framsida.