Gå til indhold

Registrering

Det er meget nemt at sammensætte dine egne blokke med Blockstudio. Udvidelsen leder efter en mappe blockstudio i det tema, der aktuelt er aktiveret. Alle undermapper med en fil block.json, der indeholder nøglen blockstudio, bliver registreret.

block.json

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

Skabelon

Den brugerdefinerede blok bliver endnu ikke registreret, fordi den mangler en skabelon. Du kan løse det ved at oprette en index.php i samme mappe som din fil block.json. Indholdet gengives automatisk, når blokken bruges.

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

Betinget logik

Blokke kan registreres betinget ved hjælp af nøglen conditions. Den understøtter alle de globale variabler, der også er tilgængelige for attributter.

Se alle betingelser

Følgende eksempel registrerer kun blokken, hvis den aktuelle indholdstype er en side:

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

Afhængigheder af udvidelser

Blokke kan afhænge af aktive WordPress-udvidelser ved hjælp af nøglen pluginDependencies. Hvis en af de angivne udvidelser ikke er aktiv, springes blokken over under registreringen.

Afhængigheder angives med WordPress-udvidelsesslugs:

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

Brug objektformen til at kræve en bestemt udvidelsesversion. Versionskrav bruger de samme operatorer som PHPs version_compare(); en version uden operator behandles som >=.

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

Brugerdefineret ikon

Brugerdefinerede SVG-ikoner til blokke kan registreres sådan her:

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

WordPress tillader ikke brugerdefinerede SVG-ikoner i sin egen block.json icon-nøgle; kun Dashicons-id’er er tilladt her.

Standardblokke i WordPress

Blockstudio registrerer også automatisk standardblokke i WordPress, som findes i dine mapper Blockstudio. Enhver block.json uden en nøgle blockstudio, men med en gyldig egenskab name, registreres via WordPresss indbyggede register_block_type().

Det betyder, at du kan placere blokke, der er oprettet med @wordpress/create-block, direkte i din mappe blockstudio/. De registreres automatisk sammen med dine blokke Blockstudio. Der er ikke brug for separat registreringskode i en udvidelse.

Kode
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

Byg din blok med npx wp-scripts build, og læg derefter outputmappen i din mappe Blockstudio. Blokken registreres automatisk.

Det samme gælder for WordPress 7.0’s PHP-baserede blokke: en block.json med autoRegister-understøttelse og en render.php kræver intet script og ingen build og registreres her som enhver anden standardblok. Core begrænser denne mulighed til simple blokke med string-, integer-, boolean- og enum-attributter; så snart en blok har brug for indre blokke, rich text, medier eller brugerdefinerede kontrolelementer, skal du enten oprette en client-side-blok eller give den en blockstudio-nøgle og blive i PHP.

HTML

Blockstudio bruger en parser til elementer af typen React til at gengive ikonelementet, så du kan bruge HTML i ikonstrengen.

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

Brugerdefinerede stier

Som standard søger Blockstudio rekursivt efter blokke i mappen blockstudio i dit aktuelle tema eller undertema. Du kan ændre denne funktionsmåde på to måder.

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';
});

Til sammensatte eller virtuelle filsystemer skal du bruge en logisk opdagelseskilde i stedet for at tilføje uafhængige stier for overordnet mappe og overlay. Logiske kilder understøtter skygning pr. sti, nedarvede søskendefiler, sletninger, cacheidentitet og oprindelse. Se Logiske opdagelseskilder.

Instanser

Hvis mulighederne ovenfor ikke er tilstrækkelige, kan du starte klassen Blockstudio\Build i de mapper, du vælger:

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

Filtrér metadata

Metadata kan filtreres, før blokken registreres, ved hjælp af filteret 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);

Ovenstående eksempel bruges internt til at give alle bibliotekselementer Blockstudio det samme ikon.