Preskočiť na obsah

Registrácia

Vytváranie vlastných blokov pomocou Blockstudio je veľmi jednoduché. Plugin vyhľadá priečinok blockstudio v aktuálne aktivovanej téme. Zaregistrujú sa všetky jeho podpriečinky, ktoré obsahujú súbor block.json s kľúčom blockstudio.

block.json

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

Šablóna

Vlastný blok zatiaľ nebude zaregistrovaný, pretože mu chýba šablóna. Vytvorte súbor index.php v rovnakom priečinku ako súbor block.json a jeho obsah sa automaticky vykreslí pri použití bloku.

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

Podmienená logika

Bloky možno registrovať podmienene pomocou kľúča conditions. Podporuje všetky globálne premenné, ktoré sú dostupné aj pre atribúty.

Zobraziť všetky podmienky

Nasledujúci príklad zaregistruje blok iba vtedy, keď je aktuálnym typom príspevku stránka:

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

Závislosti od pluginov

Bloky môžu závisieť od aktívnych pluginov WordPress pomocou kľúča pluginDependencies. Ak niektorý z uvedených pluginov nie je aktívny, blok sa pri registrácii preskočí.

Závislosti používajú identifikátory pluginov WordPress:

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

Ak chcete vyžadovať konkrétnu verziu pluginu, použite objektovú formu. Na určenie verzií sa používajú rovnaké operátory ako v version_compare() pre PHP; verzia bez operátora sa považuje za >=.

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

Vlastná ikona

Vlastné ikony SVG možno zaregistrovať pre bloky takto:

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

WordPress nepovoľuje vlastné ikony SVG vo vlastnom kľúči block.json icon; sú povolené iba ID Dashicons.

Štandardné bloky WordPress

Blockstudio tiež automaticky registruje štandardné bloky WordPress nájdené v priečinkoch Blockstudio. Každý block.json bez kľúča blockstudio, ktorý však má platnú vlastnosť name, sa zaregistruje pomocou natívneho register_block_type() v rámci WordPress.

To znamená, že bloky vytvorené pomocou @wordpress/create-block môžete umiestniť priamo do priečinka blockstudio/ a automaticky sa zaregistrujú spolu s vašimi blokmi Blockstudio. Samostatný kód na registráciu pluginu nie je potrebný.

Kód
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

Vytvorte blok pomocou npx wp-scripts build a výstupný priečinok vložte do adresára Blockstudio. Blok sa zaregistruje automaticky.

To isté platí pre bloky WordPress 7.0 PHP-only : block.json s podporou autoRegister a render.php nepotrebujú skript ani zostavenie a registrujú sa tu ako každý iný štandardný blok. Core obmedzuje túto cestu na jednoduché bloky s atribútmi typu reťazec, celé číslo, boolean a enum; keď sú potrebné vnorené bloky, formátovaný text, médiá alebo vlastné ovládacie prvky, vytvorte klientsky blok alebo mu priraďte kľúč blockstudio a zostaňte v PHP.

HTML

Blockstudio používa na vykreslenie prvku ikony parser prvkov React, takže v reťazci ikony možno použiť HTML.

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

Vlastné cesty

Predvolene Blockstudio rekurzívne prehľadáva priečinok blockstudio v aktuálnej téme alebo podradenej téme a vyhľadáva bloky. Toto správanie môžete zmeniť dvoma spôsobmi.

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

Pri zložených alebo virtuálnych súborových systémoch použite logický zdroj vyhľadávania namiesto pridávania samostatných ciest k nadradeným a prekrývajúcim sa priečinkom. Logické zdroje podporujú prekrývanie jednotlivých ciest, dedenie súrodeneckých súborov, odstraňovanie, identitu vyrovnávacej pamäte a pôvod údajov. Pozrite si Logické zdroje vyhľadávania.

Inštancie

Ak vám uvedené možnosti nestačia, môžete triedu Blockstudio\Build vytvoriť v rôznych priečinkoch podľa vlastného výberu:

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

Filtrovanie metadát

Metadáta možno filtrovať ešte pred registráciou bloku pomocou filtra 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);

Uvedený príklad sa interne používa na zjednotenie ikon všetkých prvkov knižnice Blockstudio.