Liigu sisu juurde

Registreerimine

Oma plokkide loomine Blockstudio abil on väga lihtne. Pistikprogramm otsib praegu aktiveeritud teemast kausta blockstudio. Registreeritakse kõik selle alamkaustad, mis sisaldavad blockstudio võtmega faili block.json.

block.json

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

Mall

Kohandatud plokki ei registreerita veel, sest sellel puudub mall. Probleemi lahendamiseks looge samasse kausta failiga block.json fail index.php. Selle sisu renderdatakse ploki kasutamisel automaatselt.

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

Tingimusloogika

Plokke saab registreerida tingimuslikult võtmega conditions. See toetab kõiki globaalseid muutujaid, mis on saadaval ka atribuutide jaoks.

Vaadake kõiki tingimusi

Järgmises näites registreeritakse plokk ainult siis, kui praeguse postituse tüüp on leht:

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

Pistikprogrammi sõltuvused

Plokid võivad sõltuda aktiivsetest WordPress pistikprogrammidest võtme pluginDependencies kaudu. Kui mõni loetletud pistikprogramm pole aktiivne, jäetakse plokk registreerimisel vahele.

Sõltuvuste määramisel kasutatakse WordPress pistikprogrammi nimesid:

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

Pistikprogrammi versiooni nõudmiseks kasutage objektivormi. Versioonipiirangutes kasutatakse samu tehtemärke nagu PHP puhul version_compare(); tehtemärgita versiooni käsitletakse kujul >=.

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

Kohandatud ikoon

Plokkide kohandatud SVG-ikoone saab registreerida järgmiselt:

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

WordPress ei luba oma võtmes block.json icon kohandatud SVG-ikoone kasutada; siin on lubatud ainult Dashicons ID-d.

Standardsed WordPress plokid

Blockstudio registreerib automaatselt ka standardseid WordPress plokke, mis asuvad sinu Blockstudio kataloogides. Kõik block.json-id, millel puudub blockstudio võti, kuid mille name omadus on kehtiv, registreeritakse WordPress loomuliku register_block_type() kaudu.

See tähendab, et saate @wordpress/create-block abil loodud plokid otse oma kausta blockstudio/ paigutada ning need registreeritakse automaatselt koos teie Blockstudio plokkidega. Eraldi pistikprogrammi registreerimiskoodi pole vaja.

Kood
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

Looge plokk käsuga npx wp-scripts build, seejärel paigutage väljundkaust kataloogi Blockstudio. Plokk registreeritakse automaatselt.

Sama kehtib ka WordPress 7.0 PHP-only plokkide kohta: plokk block.json koos toe autoRegister ja atribuudiga render.php ei vaja skripti ega järku ning registreeritakse siin nagu iga teine standardplokk. Tuum piirab selle võimaluse lihtsate plokkidega, mille atribuudid on stringid, täisarvud, tõeväärtused või enumid. Kui vaja läheb sisemisi plokke, rikasteksti, meediat või kohandatud juhtnuppe, looge kliendipoolne plokk või lisage sellele võti blockstudio ja kasutage PHP.

HTML

Blockstudio kasutab ikoonielemendi renderdamiseks React elemendiparserit, seega saab ikoonistringis kasutada HTML.

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

Kohandatud teed

Vaikimisi otsib Blockstudio rekursiivselt plokke kaustast blockstudio, mis asub aktiivses teemas või lapsteemas. Seda käitumist saab muuta kahel viisil.

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

Koosneva või virtuaalse failisüsteemi puhul kasutage sõltumatute ülemkausta ja ülekirjutuskausta teede lisamise asemel loogilist tuvastamisallikat. Loogilised allikad toetavad teepõhist varjamist, päritud sõsarfaile, kustutamist, vahemälu identiteeti ja päritoluteavet. Vaadake loogilisi tuvastamisallikaid.

Eksemplarid

Kui ülaltoodud valikutest ei piisa, saate klassi Blockstudio\Build käivitada enda valitud kaustades:

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

Filtri metaandmed

Metaandmeid saab enne ploki registreerimist filtriga blockstudio/blocks/meta muuta:

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

Eelmist näidet kasutatakse teegisiseselt kõigile Blockstudio teegi elementidele sama ikooni määramiseks.