Gå til indhold

Migrering fra ACF Blocks

Hvis du har bygget brugerdefinerede WordPress-blokke med ACF (Advanced Custom Fields), er det ligetil at migrere til Blockstudio. Begreberne ligner hinanden: Du definerer felter, skriver en skabelon, og blokken vises i editoren. Forskellene er, at Blockstudio selv finder blokmapper, definerer felter i sit eget skema i block.json og giver hver skabelon feltværdierne som ét $a-array.

Denne vejledning gennemgår migreringen trin for trin med sammenligninger side om side af mønstre i ACF og Blockstudio.

Den grundlæggende forskel

Siden ACF 6.0 er en ACF-blok en block.json med en nøgle acf, der angiver dens gengivelsesskabelon, og hver blokmappe registreres med sit eget register_block_type()-kald. Felterne kommer fra en feltgruppe, der er knyttet til blokken med en Block-placeringsregel (oprettet i admin, synkroniseret gennem Local JSON eller registreret med acf_add_local_field_group()), eller, siden ACF PRO 6.8.1, fra et indlejret acf.fields-array i samme block.json. Blockstudio erstatter registreringskaldet med filbaseret automatisk søgning: Opret en mappe med en block.json og en index.php, så registreres blokken automatisk.

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>

Intet registreringskald og ingen gengivelses-callback: mappestrukturen er registreringen, og felterne ligger i block.json ved siden af skabelonen. Skabelonen læser $a i stedet for at kalde get_field().

Blokregistrering

ACF

Nuværende ACF-blokke registreres fra en block.json med en nøgle acf (renderTemplate eller renderCallback samt indstillinger som blockVersion), indlæst med et eksplicit register_block_type()-kald for hver blokmappe, typisk på init i functions.php eller en pluginfil. Ældre blokke bruger muligvis stadig acf_register_block_type(), som ACF har dokumenteret som forældet siden ACF 6.0; det virker stadig, så migrér disse blokke på samme måde.

Blockstudio

Opret en mappe i dit temas blockstudio/-mappe (eller blocks/, hvis du foretrækker det). Tilføj en block.json med standardmetadata for WordPress-blokke samt en nøgle blockstudio. Så er det gjort.

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

block.json bruger standardformatet WordPress block.json med nøglen blockstudio til felter og konfiguration:

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

Adgang til feltværdier

Dette er den mest almindelige ændring, du foretager under migreringen.

ACF Blockstudio
get_field('title') $a['title']
get_field('title', $post_id) $a['title'] (altid tilgængelig)
the_field('title') <?php echo $a['title']; ?>
have_rows('items') / the_row() foreach ($a['items'] as $item)
get_sub_field('name') $item['name']

Variablen $a er en kortform af $attributes og indeholder alle feltværdier for den aktuelle blok. Den er altid tilgængelig i skabelonen, både i editoren og på frontend.

Skabelonvariabler

Blockstudio stiller flere variabler til rådighed i hver skabelon:

Variabel Kortform Beskrivelse
$attributes $a Alle feltværdier
$block $b Blokmetadata (name, title, dir, url, postId)
$context $c Forældreblokkens kontekst
$content InnerBlocks-indhold
$post_id Aktuelt indlægs-id (virker i editoren og på frontend; post_id eller postId i Twig)

Mapping af felttyper

De fleste felttyper i ACF har en direkte pendant i Blockstudio. Syntaksen for JSON er anderledes, men begreberne passer godt sammen.

Tekst- og indholdsfelter

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

Brug typen richtext med komponenten <RichText /> til redigerbar tekst i blokeditoren (ikke kun et tekstinput):

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

Billed- og filfelter

Felterne image og file i ACF svarer til 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"] }

Den returnerede objektstruktur ligner:

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

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

Tilgængelige egenskaber: ID, title, alt, caption, description, href, url, sizes. Dimensionerne er i sizes, for eksempel $a['photo']['sizes']['full-width'].

Valg, radio og afkrydsningsfelt

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

Brug "returnFormat": "both" for at hente både værdi og etiket:

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

Det samme mønster gælder for typerne radio og checkbox.

Skift og sand/falsk

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

Farve og 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 integreres med WordPress-farvepaletten. Typen gradient giver en gradientvælger.

Tal, interval og dato

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

Gentagelsesfelter

Gentagelsesfeltet i ACF svarer direkte til typen repeater i Blockstudio. ACF-skabeloner gennemløber normalt med have_rows() / the_row() / get_sub_field() (get_field() på et gentagelsesfelt returnerer også et array med rækker); Blockstudio har kun det almindelige PHP-array, allerede 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; ?>

Blockstudio-gentagelsesfelter understøtter indlejring (gentagelsesfelt i gentagelsesfelt) op til 3 niveauer.

Grupper

Gruppefeltet i ACF svarer til typen group i Blockstudio. Felt-id’er inde i grupper får gruppe-id’et som præfiks.

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ælpefunktionen bs_get_group() fjerner gruppepræfikset fra felt-id’er, så du får enkel adgang. Uden den ville du tilgå felter som $a['author_name'] og $a['author_role'].

Betinget logik

Både ACF og Blockstudio understøtter betinget logik til at vise og skjule felter baseret på værdierne i andre felter.

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

Betingelser i Blockstudio henviser direkte til felt-id’er (ikke felt-nøgler). Tilgængelige operatorer: ==, !=, includes, !includes, empty, !empty, <, >, <=, >=.

Blockstudio understøtter også globale betingelser baseret på indlægstype, indlægs-id, brugerrolle og bruger-id:

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

InnerBlocks

Både ACF og Blockstudio understøtter InnerBlocks til indlejring af andre blokke i din brugerdefinerede blok med det samme <InnerBlocks />-tag og de samme attributter allowedBlocks, template og templateLock, så denne del af en skabelon kan som regel overføres uændret.

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>

Tagget <InnerBlocks /> erstattes med komponenten React i editoren og med det gengivne blokindhold på frontend.

Lagring af indlægsmetadata

Både ACF Blocks og Blockstudio gemmer som standard feltværdier som blokattributter i indholdet af indlægget, ikke i indlægsmeta. Det betyder, at feltværdier ikke kan forespørges med WP_Query, medmindre du vælger lagring i meta.

ACF tilføjede valgfri lagring af indlægsmeta for blokke i ACF PRO 6.3 via usePostMeta: true, for én blok på øverste niveau pr. side. Blockstudio har en valgfri mekanisme pr. felt, der bruger egenskaben storage:

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

Metanøglen registreres automatisk med show_in_rest. Få adgang til den hvor som helst med get_post_meta($post_id, 'is_featured', true).

Brug lagring af indstillinger til værdier, der gælder for hele webstedet (som indstillingssider for ACF):

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

Udvidelse af eksisterende blokke

ACFs regel for blokplacering knytter feltgrupper kun til ACF-blokke; den tilføjer ikke felter til kerneblokke eller tredjepartsblokke. ACFs vej til kerneblokke som Heading, Paragraph, Image og Button er WordPress Block Bindings API, som forbinder eksisterende blokattributter med ACF-feltværdier. Blockstudio kan tilføje nye felter og kontrolelementer til enhver registreret blok via udvidelsesfiler.

Opret en udvidelsesfil i din blockstudio-mappe:

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

Egenskaben set anvender automatisk feltværdien på blokkens HTML. Brug jokertegn til at udvide flere blokke på én gang: "name": "core/*".

Tjekliste til migrering

  1. Opret blokmappen i theme/blockstudio/{block-name}/ med block.json og index.php.
  2. Flyt feltdefinitioner fra blokkens feltgruppe (Local JSON, acf_add_local_field_group() eller et inline acf.fields-array) til arrayet blockstudio.attributes i block.json. Skift name til id, fjern key, og tilpas typenavne efter behov.
  3. Opdater adgang i skabeloner fra get_field('name') til $a['name']. Erstat have_rows()-løkker med foreach ($a['repeater'] as $item).
  4. Erstat get_sub_field() med direkte adgang til arrayet: $item['fieldId'].
  5. Tilføj useBlockProps til det yderste element i din skabelon for korrekt integration med editoren.
  6. Flyt betinget logik fra ACFs conditional_logic til Blockstudios conditions, og brug felt-id’er i stedet for feltnøgler.
  7. Tilføj lagring for felter, der tidligere blev forespurgt via get_post_meta() eller brugt i WP_Query.
  8. Fjern registreringskode for ACF: register_block_type()-kaldene og acf-nøglerne for de migrerede blokke (eller deres acf_register_block_type()-kald) samt deres feltgrupper, uanset om de findes i Local JSON, acf_add_local_field_group(), et inline acf.fields-array eller i administrationen.
  9. Test i editoren for at kontrollere, at felterne vises korrekt, og kontrollér derefter outputtet på frontend.