Treci la conținut

Înregistrare

Combinarea propriilor blocuri cu Blockstudio este foarte ușoară. Extensia va căuta un folder blockstudio în tema activată în prezent. În acesta, vor fi înregistrate toate subfolderele care conțin un fișier block.json cu o cheie blockstudio.

block.json

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

Șablon

Până acum, blocul personalizat nu va fi înregistrat, deoarece îi lipsește un șablon. Pentru a remedia acest lucru, creați un index.php în același folder cu fișierul block.json, iar conținutul său va fi redat automat când este folosit blocul.

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

Logică condițională

Blocurile pot fi înregistrate condiționat folosind cheia conditions. Aceasta acceptă toate variabilele globale disponibile și pentru atribute.

Vedeți toate condițiile

Următorul exemplu va înregistra blocul doar dacă tipul de conținut curent este o pagină:

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

Dependențe de extensii

Blocurile pot depinde de extensii WordPress active folosind cheia pluginDependencies. Dacă una dintre extensiile listate este inactivă, blocul este omis în timpul înregistrării.

Dependențele folosesc identificatorii extensiilor WordPress:

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

Folosiți forma de obiect pentru a impune o versiune a extensiei. Constrângerile de versiune folosesc aceiași operatori ca PHP în version_compare(); o versiune fără operator este considerată >=.

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

Pictogramă personalizată

Pictogramele SVG personalizate pentru blocuri pot fi înregistrate astfel:

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

WordPress nu permite pictograme SVG personalizate în propria cheie block.json icon; aici sunt permise doar ID-urile Dashicons.

Blocuri WordPress standard

Blockstudio înregistrează automat și blocurile standard WordPress găsite în directoarele Blockstudio. Orice block.json fără o cheie blockstudio, dar cu o proprietate name validă, este înregistrat prin WordPress nativ al register_block_type().

Astfel, puteți plasa blocuri create cu @wordpress/create-block direct în folderul blockstudio/, iar acestea vor fi înregistrate automat alături de blocurile Blockstudio. Nu este nevoie de cod separat pentru înregistrarea extensiei.

Cod
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

Creați blocul cu npx wp-scripts build, apoi copiați folderul rezultat în folderul Blockstudio. Blocul va fi înregistrat automat.

Același lucru este valabil și pentru blocurile PHP doar pentru WordPress 7.0: un block.json cu suport autoRegister și un render.php nu necesită script sau compilare și este înregistrat aici ca orice alt bloc standard. Nucleul limitează această cale la blocuri simple, cu atribute de tip șir, întreg, boolean și enumerare; de îndată ce este nevoie de blocuri interioare, text îmbogățit, media sau comenzi personalizate, creați un bloc pe partea clientului sau adăugați-i o cheie blockstudio și folosiți în continuare PHP.

HTML

Blockstudio folosește un parser de elemente React pentru a reda elementul pictogramei, deci este posibil să folosiți HTML în șirul pictogramei.

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

Căi personalizate

În mod implicit, Blockstudio caută recursiv blocuri în folderul blockstudio din tema curentă sau din tema copil. Puteți schimba acest comportament în două moduri.

Filtru

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

Pentru sistemele de fișiere compuse sau virtuale, folosiți o sursă logică de descoperire în loc să adăugați căi separate pentru părinte și suprapunere. Sursele logice acceptă mascarea pe cale, fișiere înrudite moștenite, ștergeri, identitatea memoriei cache și proveniența. Consultați Surse logice de descoperire.

Instanțe

Dacă opțiunile de mai sus nu sunt suficiente, puteți inițializa clasa Blockstudio\Build în diverse foldere alese de dumneavoastră:

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

Filtrarea metadatelor

Metadatele pot fi filtrate înainte de înregistrarea blocului folosind filtrul 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);

Exemplul de mai sus este folosit intern pentru a atribui aceeași pictogramă tuturor elementelor bibliotecii Blockstudio.