Hoppa till innehåll

Registrering

Det är mycket enkelt att skapa egna block med Blockstudio. Tillägget letar efter en mapp blockstudio i det för närvarande aktiva temat. Alla undermappar där som innehåller en fil block.json med nyckeln blockstudio registreras.

block.json

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

Mall

Det anpassade blocket registreras ännu inte eftersom det saknar en mall. Lös det genom att skapa en index.php i samma mapp som filen block.json. Innehållet återges då automatiskt när blocket används.

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

Villkorslogik

Block kan registreras villkorligt med nyckeln conditions. Den stöder alla globala variabler som också är tillgängliga för attribut.

Visa alla villkor

Följande exempel registrerar blocket endast om den aktuella inläggstypen är en sida:

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

Insticksberoenden

Block kan vara beroende av aktiva tillägg i WordPress med nyckeln pluginDependencies. Om ett av de angivna tilläggen är inaktivt hoppas blocket över vid registreringen.

Beroenden använder tilläggens WordPress-sluggar:

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

Använd objektformen för att kräva en tilläggsversion. Versionsvillkoren använder samma operatorer som PHPs version_compare(); en version utan operator tolkas som >=.

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

Anpassad ikon

Anpassade SVG-ikoner för block kan registreras så här:

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

WordPress tillåter inte anpassade SVG-ikoner i sin egen nyckel block.json icon, endast ID:n för Dashicons är tillåtna här.

Standardblock i WordPress

Blockstudio registrerar också automatiskt standardblock i WordPress som finns i dina kataloger Blockstudio. Alla block.json utan nyckeln blockstudio men med en giltig egenskap name registreras via WordPresss inbyggda register_block_type().

Det innebär att du kan lägga block som skapats med @wordpress/create-block direkt i din mapp blockstudio/. De registreras då automatiskt tillsammans med dina Blockstudio-block. Ingen separat registreringskod för tillägget behövs.

Kod
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

Bygg ditt block med npx wp-scripts build och lägg sedan den färdiga mappen i din katalog Blockstudio. Blocket registreras automatiskt.

Samma sak gäller block i PHP-versionen av WordPress 7.0: en block.json med stöd för autoRegister och en render.php behöver varken skript eller bygge och registreras här som alla andra standardblock. WordPress begränsar den här vägen till enkla block med attribut av typen sträng, heltal, boolean och enum. Så snart ett block behöver inre block, formaterad text, media eller anpassade kontroller kan du antingen skapa ett klientbaserat block eller ge det nyckeln blockstudio och fortsätta använda PHP.

HTML

Blockstudio använder en parser för element av typen React för att återge ikonelementet, så det går att använda HTML i ikonens sträng.

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

Anpassade sökvägar

Som standard söker Blockstudio rekursivt efter block i mappen blockstudio i det aktuella temat eller barntemat. Du kan ändra det på två sätt.

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

För sammansatta eller virtuella filsystem kan du använda en logisk identifieringskälla i stället för att lägga till separata sökvägar för föräldramappar och överlagringsmappar. Logiska källor stöder överlagring per sökväg, nedärvda syskonfiler, borttagningar, cacheidentitet och proveniens. Se Logiska identifieringskällor.

Instanser

Om alternativen ovan inte räcker kan du initiera klassen Blockstudio\Build för olika mappar som du väljer:

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

Filtrera metadata

Metadata kan filtreras innan blocket registreras med filtret 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);

Exemplet ovan används internt för att ge alla biblioteksobjekt i Blockstudio samma ikon.