Pāriet uz saturu

Reģistrēšana

Savu bloku izveide ar Blockstudio ir ļoti vienkārša. Spraudnis meklēs mapi blockstudio jūsu pašlaik aktivizētajā motīvā. Tajā tiks reģistrētas visas apakšmapes, kurās ir fails block.json ar atslēgu blockstudio.

block.json

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

Veidne

Pagaidām pielāgotais bloks netiks reģistrēts, jo tam trūkst veidnes. Lai to novērstu, izveidojiet index.php tajā pašā mapē, kur atrodas jūsu fails block.json. Tā saturs tiks automātiski attēlots, kad bloks tiks izmantots.

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

Nosacījumu loģika

Blokus var reģistrēt nosacīti, izmantojot atslēgu conditions. Tā atbalsta visus globālos mainīgos, kas pieejami arī atribūtiem.

Skatīt visus nosacījumus

Tālāk sniegtajā piemērā bloks tiks reģistrēts tikai tad, ja pašreizējais ieraksta tips ir lapa:

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

Spraudņu atkarības

Bloki var būt atkarīgi no aktīviem WordPress spraudņiem, izmantojot atslēgu pluginDependencies. Ja kāds no sarakstā iekļautajiem spraudņiem nav aktīvs, bloks reģistrēšanas laikā tiek izlaists.

Atkarībās tiek izmantoti WordPress spraudņu identifikatori:

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

Izmantojiet objekta formu, lai norādītu nepieciešamo spraudņa versiju. Versiju ierobežojumiem tiek izmantoti tie paši operatori, kas PHP komponentā version_compare(); versija bez operatora tiek uzskatīta par >=.

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

Pielāgota ikona

Pielāgotas SVG ikonas blokiem var reģistrēt šādi:

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

WordPress savā block.json icon atslēgā neļauj izmantot pielāgotas SVG ikonas. Šeit ir atļauti tikai Dashicons ID.

Standarta WordPress bloki

Blockstudio arī automātiski reģistrē standarta WordPress blokus, kas atrodami jūsu Blockstudio direktorijos. Jebkurš block.json bez atslēgas blockstudio, bet ar derīgu īpašību name, tiek reģistrēts, izmantojot WordPress sākotnējo register_block_type().

Tas nozīmē, ka ar @wordpress/create-block izveidotos blokus var ievietot tieši savā mapē blockstudio/, un tie tiks automātiski reģistrēti līdzās jūsu Blockstudio blokiem. Atsevišķs spraudņa reģistrācijas kods nav nepieciešams.

Kods
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

Izveidojiet bloku ar npx wp-scripts build, pēc tam ievietojiet izvades mapi savā direktorijā Blockstudio. Bloks tiks reģistrēts automātiski.

Tas pats attiecas uz WordPress 7.0 PHP tikai blokiem: block.json ar atbalstu autoRegister un render.php nav vajadzīgs ne skripts, ne būvēšana, un tas tiek reģistrēts šeit tāpat kā jebkurš cits standarta bloks. Kodols šo iespēju ierobežo līdz vienkāršiem blokiem ar virknes, vesela skaitļa, Būla un uzskaitījuma atribūtiem. Tiklīdz nepieciešami iekšējie bloki, bagātināts teksts, multivide vai pielāgotas vadīklas, izveidojiet klienta puses bloku vai pievienojiet tam atslēgu blockstudio un palieciet PHP.

HTML

Blockstudio izmanto React elementu parsētāju, lai attēlotu ikonas elementu, tāpēc ikonas virknē var izmantot HTML.

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

Pielāgotie ceļi

Pēc noklusējuma Blockstudio rekursīvi meklē blokus mapē blockstudio jūsu pašreizējā motīvā vai bērnmotīvā. Šo darbību var mainīt divos veidos.

Filtrs

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

Apvienotām vai virtuālām failu sistēmām izmantojiet loģisku atklāšanas avotu, nevis pievienojiet atsevišķus vecākmapes un pārklājuma ceļus. Loģiskie avoti atbalsta katra ceļa aizstāšanu, mantotos blakusesošos failus, dzēšanu, kešatmiņas identitāti un izcelsmes izsekošanu. Skatiet Loģiskie atklāšanas avoti.

Instanču izveide

Ja ar iepriekš minētajām opcijām nepietiek, klasi Blockstudio\Build var izveidot dažādās jūsu izvēlētās mapēs:

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

Metadatu filtrēšana

Metadatus var filtrēt pirms bloka reģistrēšanas, izmantojot filtru 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);

Iepriekš minētais piemērs tiek izmantots iekšēji, lai visiem Blockstudio bibliotēkas elementiem piešķirtu vienu un to pašu ikonu.