Ugrás a tartalomhoz

Regisztrálás

Saját blokkok összeállítása a Blockstudio segítségével rendkívül egyszerű. A bővítmény az aktuálisan aktivált témán belül egy blockstudio mappát keres. Az ezen belüli block.json fájlt tartalmazó almappák akkor kerülnek regisztrálásra, ha a fájlban van blockstudio kulcs.

block.json

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

Sablon

A rendszer egyelőre nem regisztrálja az egyéni blokkot, mert hiányzik a sablonja. A megoldáshoz hozz létre egy index.php fájlt ugyanabban a mappában, mint a block.json fájl. A tartalma automatikusan megjelenik a blokk használatakor.

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

Feltételes logika

A blokkok feltételesen is regisztrálhatók a conditions kulccsal. Ez az attribútumokhoz is elérhető összes globális változót támogatja.

Az összes feltétel megtekintése

Az alábbi példa csak akkor regisztrálja a blokkot, ha az aktuális bejegyzéstípus oldal:

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

Bővítményfüggőségek

A blokkok az aktív WordPress bővítményektől függhetnek a pluginDependencies kulcs segítségével. Ha a felsorolt bővítmények egyike sem aktív, a blokk kimarad a regisztrációból.

A függőségek a WordPress bővítmény azonosítóit használják:

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

Az objektumalak segítségével bővítményverziót követelhetsz meg. A verziókorlátozások ugyanazokat a műveleti jeleket használják, mint a PHP version_compare() eleme; műveleti jel nélküli verzió esetén a >= érték érvényes.

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

Egyéni ikon

Az egyéni blokkokhoz tartozó SVG-ikonok így regisztrálhatók:

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

A WordPress nem engedélyez egyéni SVG-ikonokat a saját block.json icon kulcsában, itt csak Dashicons-azonosítók használhatók.

Szabványos WordPress blokkok

A Blockstudio automatikusan regisztrálja az Blockstudio könyvtáraiban található szabványos WordPress blokkokat is. Minden olyan block.json fájl regisztrálásra kerül az WordPress natív register_block_type() funkciójával, amelyből hiányzik a blockstudio kulcs, de érvényes name tulajdonsággal rendelkezik.

Ez azt jelenti, hogy a @wordpress/create-block segítségével létrehozott blokkokat közvetlenül a blockstudio/ mappába helyezheted, és azok automatikusan regisztrálódnak a Blockstudio blokkok mellett. Nincs szükség külön bővítményregisztrációs kódra.

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

Készítsd el a blokkot a npx wp-scripts build segítségével, majd helyezd a kimeneti mappát a Blockstudio könyvtárba. A blokk automatikusan regisztrálódik.

Ugyanez érvényes a WordPress 7.0 PHP-alapú blokkjaira is: autoRegister támogatással rendelkező block.json és render.php esetén nincs szükség szkriptre vagy összeállításra, a blokkok pedig itt ugyanúgy regisztrálódnak, mint bármely más szabványos blokk. A WordPress csak az egyszerű, szöveges, egész szám, logikai vagy felsorolás attribútumokkal rendelkező blokkokra korlátozza ezt a lehetőséget; ha belső blokkokra, RichText mezőre, médiára vagy egyéni vezérlőkre van szükség, hozz létre kliensoldali blokkot, vagy adj hozzá blockstudio kulcsot, és maradj a PHP környezetben.

HTML

A Blockstudio egy React elemfeldolgozót használ az ikon elemének megjelenítéséhez, így a HTML használható az ikont tartalmazó szövegben.

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

Egyéni útvonalak

Alapértelmezés szerint a Blockstudio rekurzívan végigkeresi az aktuális témád vagy gyermektémád blockstudio mappáját blokkok után kutatva. Ezt kétféleképpen módosíthatod.

Szűrő

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

Összetett vagy virtuális fájlrendszerek esetén különálló szülő- és fedőútvonalak hozzáadása helyett használj logikai felderítési forrást. A logikai források támogatják az útvonalankénti felülírást, az örökölt testvérfájlokat, a törléseket, a gyorsítótár-azonosítást és az eredetkövetést. Lásd: Logikai felderítési források.

Példányok

Ha a fenti lehetőségek nem elegendők, a Blockstudio\Build osztályt tetszőleges mappákra is példányosíthatod:

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

Metaadatok szűrése

A metaadatok a blokk regisztrálása előtt a blockstudio/blocks/meta szűrővel szűrhetők:

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

A fenti példa belsőleg arra szolgál, hogy a Blockstudio könyvtár összes eleméhez ugyanazt az ikont rendelje.