Preskoči na vsebino

Registracija

S Blockstudio lahko zelo preprosto sestavite lastne bloke. Vtičnik bo v trenutno aktivni temi poiskal mapo blockstudio. Registriral bo vse podmape, ki vsebujejo datoteko block.json s ključem blockstudio.

block.json

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

Predloga

Zaenkrat blok po meri še ne bo registriran, ker nima predloge. To popravite tako, da v isto mapo kot datoteko block.json dodate index.php; njena vsebina se bo samodejno izrisala, ko boste uporabili blok.

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

Pogojna logika

Bloke je mogoče registrirati pogojno s ključem conditions. Podpira vse globalne spremenljivke, ki so na voljo tudi za atribute.

Oglejte si vse pogoje

Naslednji primer registrira blok samo, če je trenutna vrsta prispevka stran:

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

Odvisnosti od vtičnikov

Bloki so lahko odvisni od aktivnih vtičnikov WordPress prek ključa pluginDependencies. Če kateri od navedenih vtičnikov ni aktiven, je blok med registracijo preskočen.

Odvisnosti uporabljajo polže vtičnikov WordPress:

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

Z obliko objekta lahko zahtevate določeno različico vtičnika. Omejitve različic uporabljajo iste operatorje kot PHP pri version_compare(); različica brez operatorja se obravnava kot >=.

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

Ikona po meri

Ikone SVG po meri za bloke lahko registrirate takole:

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

WordPress ne dovoljuje ikon SVG po meri znotraj lastnega ključa block.json icon; dovoljeni so samo ID-ji Dashicons.

Standardni bloki WordPress

Blockstudio samodejno registrira tudi standardne bloke WordPress, najdene v vaših imenikih Blockstudio. Vsak block.json brez ključa blockstudio, ki pa ima veljavno lastnost name, se registrira prek izvornega register_block_type() komponente WordPress.

To pomeni, da lahko bloke, ustvarjene z orodjem @wordpress/create-block, postavite neposredno v mapo blockstudio/ in registrirani bodo samodejno skupaj z vašimi bloki Blockstudio. Ločena koda za registracijo vtičnika ni potrebna.

Koda
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

Blok ustvarite z orodjem npx wp-scripts build, nato pa izhodno mapo premaknite v imenik Blockstudio. Registriran bo samodejno.

Enako velja za bloke PHP samo za WordPress 7.0: block.json s podporo autoRegister in z render.php ne potrebuje skriptov ali gradnje ter se tukaj registrira kot vsak drug standardni blok. Jedro to pot omejuje na preproste bloke z atributi vrste niz, celo število, logična vrednost in enum. Ko blok potrebuje notranje bloke, obogateno besedilo, predstavnost ali kontrolnike po meri, ustvarite blok na strani odjemalca ali mu dodajte ključ blockstudio in ostanite v PHP.

HTML

Blockstudio za izris elementa ikone uporablja razčlenjevalnik elementov React, zato je mogoče v nizu ikone uporabiti HTML.

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

Poti po meri

Privzeto bo Blockstudio rekurzivno iskal bloke v mapi blockstudio znotraj trenutne teme ali podrejene teme. To vedenje lahko spremenite na dva načina.

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

Za sestavljene ali navidezne datotečne sisteme uporabite logični vir odkrivanja namesto dodajanja neodvisnih nadrejenih in prekrivnih poti. Logični viri podpirajo prekrivanje po posamezni poti, podedovane sosednje datoteke, brisanja, identiteto predpomnilnika in izvor. Glejte Logični viri odkrivanja.

Primerki

Če zgornje možnosti ne zadoščajo, lahko razred Blockstudio\Build ustvarite v izbranih mapah:

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

Metapodatki filtra

Metapodatke je mogoče filtrirati pred registracijo bloka s filtrom 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);

Zgornji primer se interno uporablja za poenotenje ikone za vse elemente knjižnice Blockstudio.