Ga naar de inhoud

InnerBlocks

Met binnenste blokken kun je extra blokken aan je blokken toevoegen. Onder de motorkap gebruikt Blockstudio de component InnerBlocks. Houd er rekening mee dat je per blok maar één InnerBlocks-component kunt gebruiken; dit is een WordPress-beperking.

Basisgebruik

Voeg de component <InnerBlocks /> toe aan je bloktemplate om InnerBlocks te gebruiken:

PHP
<InnerBlocks />

Je bepaalt zelf hoe je de component samenstelt. Je kunt de component InnerBlocks zo diep nesten als je wilt of hem op zichzelf gebruiken.

Eigenschappen

allowedBlocks

Met de prop allowedBlocks kun je bepalen welke blokken in de component InnerBlocks kunnen worden ingevoegd.

PHP

PHP
<InnerBlocks allowedBlocks="<?php echo esc_attr(wp_json_encode(['core/heading', 'core/paragraph'])); ?>" />

Twig

Twig
<InnerBlocks allowedBlocks="{{ ['core/heading', 'core/paragraph']|json_encode|escape('html_attr') }}" />

allowedBlocks accepteert ook serveruitgebreide tokens. Tokens worden uitgebreid voordat de editor de template ontvangt; letterlijke bloknamen blijven ongewijzigd.

Token Beschrijving
namespace/* Elk geregistreerd blok in die namespace
category:<slug> Elk geregistreerd blok in die blokcategorie van WordPress
@theme Elk Blockstudio-blok dat vanuit het actieve thema is geregistreerd

Uitgebreide items worden ontdubbeld in de volgorde waarin de auteur ze heeft opgegeven:

PHP
<InnerBlocks allowedBlocks="<?php echo esc_attr(wp_json_encode([
  'core/paragraph',
  'category:content',
  'bsui/field',
])); ?>" />

Tokens die naar geen enkel blok verwijzen, worden genegeerd. De frontenduitvoer blijft ongewijzigd, omdat allowedBlocks alleen door de editor wordt gebruikt.

tag

Standaard wordt de component InnerBlocks als een div-element gerenderd. Je kunt dit wijzigen met de prop tag.

PHP
<InnerBlocks tag="section" />

template

Met de prop template kun je een template voor de component InnerBlocks definiëren.

PHP

PHP
<InnerBlocks template="<?php echo esc_attr(wp_json_encode([
  ['core/heading', ['placeholder' => 'Book Title']],
  ['core/paragraph', ['placeholder' => 'Summary']]
])); ?>" />

Twig

Twig
<InnerBlocks template="{{ [
  ['core/heading', { placeholder: 'Book Title' }],
  ['core/paragraph', { placeholder: 'Summary' }]
]|json_encode|escape('html_attr') }}" />

templateLock

Met de prop templateLock kun je bepalen of de template kan worden aangepast.

Waarde Beschrijving
contentOnly Voorkomt alle bewerkingen. Bloktypen zonder inhoud worden verborgen in de lijstweergave. Kindblokken kunnen dit niet overschrijven.
all Voorkomt alle bewerkingen. Blokken kunnen niet worden ingevoegd, verplaatst of verwijderd.
insert Voorkomt dat blokken worden ingevoegd of verwijderd, maar bestaande blokken kunnen wel worden verplaatst.
false Voorkomt dat vergrendeling wordt toegepast, zelfs als een ouderblok een vergrendeling bevat.

renderAppender

Met de prop renderAppender kun je het type bloktoevoeger bepalen.

Waarde Beschrijving
default De standaardbloktoevoeger weergeven (toevoeger in alineastijl wanneer het alineablok is toegestaan)
button Een plusknop als bloktoevoeger weergeven

useBlockProps

useBlockProps verwijdert de buitenste wrapper van de component InnerBlocks in de editor. Zie useBlockProps voor meer informatie.

Context

Registreren

Blockstudio ondersteunt context voor de component InnerBlocks. Hiermee kun je data doorgeven van het bovenliggende blok aan de onderliggende blokken. Hoewel hiervoor onder water het WordPress kernmechanisme voor context wordt gebruikt, biedt Blockstudio een handigere API.

In plaats van alle attributen die in de context moeten worden doorgegeven apart te definiëren, kun je je eenvoudig abonneren op alle attributen van een bovenliggend blok.

Elk onderliggend blok ontvangt de waarden van zijn eigen bovenliggende blok, ook bij de eerste vooraf geladen weergave in de editor. Als je de velden van een provider bijwerkt, worden de onderliggende blokken in de editor bijgewerkt, zelfs als een eerdere weergave nog wordt geladen. Identieke onderliggende blokken onder verschillende providers behouden afzonderlijke, contextbewuste gecachete weergaven.

Stel dat je een containerblok als volgt hebt ingesteld:

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "blockstudio/container",
  "title": "Container",
  "category": "design",
  "icon": "star-filled",
  "description": "Container block.",
  "blockstudio": {
    "attributes": [
      {
        "id": "full-width",
        "type": "toggle",
        "label": "Makes section full width"
      }
    ]
  }
}

Gebruik in je onderliggende blok de eigenschap usesContext met de naam van het bovenliggende blok om toegang te krijgen tot alle attributen van het bovenliggende blok in je bloktemplate.

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "blockstudio/element",
  "title": "Element",
  "category": "design",
  "icon": "star-filled",
  "description": "Element block.",
  "usesContext": ["blockstudio/container"],
  "parent": ["blockstudio/container"],
  "blockstudio": true
}

Templates

De variabelen $context en $c zijn beschikbaar in je bloktemplates om toegang te krijgen tot alle attributen van het bovenliggende blok. Onderliggende blokken worden automatisch opnieuw geladen in de editor als de gegevens van het bovenliggende blok veranderen.

PHP

PHP
<?php $container = $context['blockstudio/container']; ?>

<h1>
  <?php echo $container['full-width']
      ? 'is full width'
      : 'no full width'; ?>
</h1>

Twig

Twig
{% set container = context['blockstudio/container'] %}

<h1>
  {{ container['full-width']
      ? 'is full width'
      : 'no full width' }}
</h1>

Frontend-wrapper

InnerBlocks moet in de editor een wrapper-element rond de onderliggende elementen renderen, maar je kunt dit aan de frontend verwijderen met het filter blockstudio/blocks/components/inner_blocks/frontend/wrap.

PHP
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
  return false; // Remove wrapper
}, 10, 2);

Vroegtijdig retourneren

Als je de methode render van je blok vroegtijdig wilt beëindigen, kun je controleren of de variabele $innerBlocks leeg is. Dit is handig als je niets wilt renderen wanneer er geen binnenste blokken zijn.

PHP
<?php if (strip_tags($innerBlocks) === '') {
  return;
} ?>
<InnerBlocks tag="section" />

Omdat <InnerBlocks/> altijd een lege alineatag rendert, kun je de functie strip_tags gebruiken om te controleren of de inhoud leeg is.

Dynamische templates

De veldtypen Select en Radio ondersteunen het dynamisch genereren van de template InnerBlocks op basis van de veldwaarde. Dit is handig als je de gebruiker een andere template wilt laten kiezen voor de component InnerBlocks.

Voeg hiervoor eenvoudig een sleutel innerBlocks toe aan de optiesarray met de template:

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "blockstudio/dynamic-layout",
  "title": "Dynamic Layout",
  "blockstudio": {
    "attributes": [
      {
        "id": "layout",
        "type": "select",
        "label": "Layout",
        "options": [
          {
            "value": "1",
            "label": "Two Columns",
            "innerBlocks": [
              {
                "name": "core/columns",
                "innerBlocks": [
                  {
                    "name": "core/column",
                    "innerBlocks": [
                      {
                        "name": "core/heading",
                        "attributes": {
                          "content": "Left Heading",
                          "level": 1
                        }
                      }
                    ]
                  },
                  {
                    "name": "core/column",
                    "innerBlocks": [
                      {
                        "name": "core/heading",
                        "attributes": {
                          "content": "Right Heading",
                          "level": 1
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "value": "2",
            "label": "Single Column",
            "innerBlocks": [
              {
                "name": "core/heading",
                "attributes": {
                  "content": "Main Heading",
                  "level": 1
                }
              },
              {
                "name": "core/paragraph",
                "attributes": {
                  "content": "Main content goes here."
                }
              }
            ]
          }
        ],
        "allowNull": "Select a layout"
      }
    ]
  }
}

Blockcontext en communicatie

Leer hoe bovenliggende en onderliggende blokken gegevens delen via context.