Ga naar de inhoud

Registratie

Eigen blokken samenstellen met Blockstudio is heel eenvoudig. De plug-in zoekt naar een map blockstudio in het momenteel geactiveerde thema. Alle submappen met een bestand block.json met een sleutel blockstudio worden daarin geregistreerd.

block.json

JSON
{
  "name": "blockstudio/native",
  "title": "Native Block",
  "category": "text",
  "icon": "star-filled",
  "description": "Native Blockstudio block.",
  "blockstudio": true
}

Template

Het aangepaste blok wordt nog niet geregistreerd omdat er een template ontbreekt. Los dit op door een index.php te maken in dezelfde map als je bestand block.json; de inhoud ervan wordt automatisch weergegeven wanneer je blok wordt gebruikt.

PHP
<h1>My first native block.</h1>

Voorwaardelijke logica

Je kunt blokken voorwaardelijk registreren met de sleutel conditions. Deze ondersteunt alle globale variabelen die ook beschikbaar zijn voor attributen.

Bekijk alle voorwaarden

In het volgende voorbeeld wordt het blok alleen geregistreerd als het huidige berichttype een pagina is:

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

Plug-in-afhankelijkheden

Blokken kunnen afhankelijk zijn van actieve plug-ins WordPress met behulp van de sleutel pluginDependencies. Als een van de vermelde plug-ins inactief is, wordt het blok overgeslagen bij de registratie.

Afhankelijkheden gebruiken de slug van de WordPress-plug-in:

JSON
{
  "blockstudio": {
    "pluginDependencies": [
      "woocommerce",
      "advanced-custom-fields"
    ]
  }
}

Gebruik de objectvorm om een plug-inversie te vereisen. Versiebeperkingen gebruiken dezelfde operatoren als PHPversion_compare(); een versie zonder operator wordt behandeld als >=.

JSON
{
  "blockstudio": {
    "pluginDependencies": {
      "woocommerce": {
        "version": ">6"
      }
    }
  }
}

Aangepast pictogram

Aangepaste SVG-pictogrammen voor blokken kunnen als volgt worden geregistreerd:

JSON
{
  "blockstudio": {
    "icon": "<svg></svg>"
  }
}

WordPress staat geen aangepaste SVG-pictogrammen toe in de eigen sleutel block.json icon; alleen Dashicons-ID’s zijn hier toegestaan.

Standaard WordPress-blokken

Blockstudio registreert ook automatisch standaard WordPress-blokken in je mappen Blockstudio. Elk block.json zonder sleutel blockstudio, maar met een juist geconfigureerde eigenschap name, wordt geregistreerd via de ingebouwde register_block_type() van WordPress.

Dit betekent dat je blokken die zijn aangemaakt met @wordpress/create-block rechtstreeks in je map blockstudio/ kunt plaatsen. Ze worden dan automatisch geregistreerd naast je Blockstudio-blokken. Aparte registratiecode voor plug-ins is niet nodig.

Code
blockstudio/
├── hero/
│   ├── block.json          ← Blockstudio block (has "blockstudio" key)
│   └── index.twig
├── my-js-block/
│   ├── block.json          ← Standard WP block (no "blockstudio" key)
│   ├── index.js            ← Compiled editor script
│   ├── index.css
│   ├── style-index.css
│   └── render.php

Bouw je blok met npx wp-scripts build en plaats de uitvoermap vervolgens in je map Blockstudio. Het blok wordt automatisch geregistreerd.

Hetzelfde geldt voor WordPress 7.0-blokken die alleen PHP gebruiken: een block.json met ondersteuning voor autoRegister en een render.php hebben geen script en geen build nodig, en worden hier net als elk ander standaardblok geregistreerd. Core beperkt die route tot eenvoudige blokken met string-, integer-, boolean- en enum-attributen; zodra een blok innerlijke blokken, rich text, media of aangepaste bedieningselementen nodig heeft, scaffold je een client-side block of geef je het een sleutel blockstudio en blijf je bij PHP.

HTML

Blockstudio gebruikt een parser voor React-elementen om het pictogramelement te renderen, dus je kunt HTML gebruiken in de pictogramreeks.

JSON
{
  "blockstudio": {
    "icon": "<div>:-)</div>"
  }
}

Aangepaste paden

Standaard doorzoekt Blockstudio recursief de map blockstudio in je huidige thema of child theme op blokken. Je kunt dit gedrag op twee manieren wijzigen.

Filter

PHP
// Custom path within your theme.
add_filter('blockstudio/path', function () {
    return get_template_directory() . '/blocks';
});

// Custom path within a plugin.
add_filter('blockstudio/path', function () {
    return WP_PLUGIN_DIR . '/my-custom-plugin/blocks';
});

Gebruik voor samengestelde bestandssystemen of virtuele bestandssystemen een logische ontdekkingsbron in plaats van afzonderlijke bovenliggende en overlaypaden toe te voegen. Logische bronnen ondersteunen overschaduwing per pad, geërfde bestanden op hetzelfde niveau, verwijderingen, cache-identiteit en herkomst. Zie Logische ontdekkingsbronnen.

Instanties

Als de bovenstaande opties niet volstaan, kun je de klasse Blockstudio\Build initialiseren op verschillende mappen naar keuze:

PHP
add_action('init', function () {
  Blockstudio\Build::init([
    'dir' => get_template_directory() . '/client-blocks'
  ]);
});

Metagegevens filteren

Metagegevens kunnen worden gefilterd voordat het blok wordt geregistreerd, met het filter blockstudio/blocks/meta:

PHP
add_filter('blockstudio/blocks/meta', function ($meta, $block) {
    if (str_starts_with($block['name'], 'marketing')) {
        $meta['icon'] = 'megaphone';
    }
    return $meta;
}, 10, 2);

Het bovenstaande voorbeeld wordt intern gebruikt om alle elementen van de Blockstudio-bibliotheek hetzelfde pictogram te geven.