Siirry sisältöön

Rekisteröinti

Omien lohkojen koostaminen ominaisuudella Blockstudio on erittäin helppoa. Lisäosa etsii parhaillaan käytössä olevan teeman sisältä kansion blockstudio. Sen kaikki alikansiot, joissa on tiedosto block.json ja avain blockstudio, rekisteröidään.

block.json

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

Malli

Mukautettua lohkoa ei vielä rekisteröidä, koska siitä puuttuu malli. Korjaa tämä luomalla index.php samaan kansioon kuin tiedosto block.json. Sen sisältö renderöidään automaattisesti, kun lohkoa käytetään.

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

Ehdollinen logiikka

Lohkoja voi rekisteröidä ehdollisesti avaimella conditions. Se tukee kaikkia yleisiä muuttujia, jotka ovat käytettävissä myös attribuuteissa.

Näytä kaikki ehdot

Seuraavassa esimerkissä lohko rekisteröidään vain, jos nykyisen julkaisun tyyppi on sivu:

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

Lisäosariippuvuudet

Lohkot voivat riippua aktiivisista WordPress-lisäosista avaimen pluginDependencies avulla. Jos jokin luetelluista lisäosista ei ole aktiivinen, lohko ohitetaan rekisteröinnin aikana.

Riippuvuuksissa käytetään WordPress-lisäosien tunnuksia:

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

Käytä objektimuotoa, kun haluat vaatia tietyn lisäosaversion. Versiorajoitteissa käytetään samoja operaattoreita kuin PHPn version_compare()-määrityksissä; versio ilman operaattoria tulkitaan arvoksi >=.

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

Mukautettu kuvake

Lohkoille voi rekisteröidä mukautettuja SVG-kuvakkeita näin:

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

WordPress ei salli mukautettuja SVG-kuvakkeita omassa block.json icon -avaimessaan, vaan ainoastaan Dashicons -tunnukset ovat sallittuja.

Vakiomuotoiset WordPress-lohkot

Blockstudio rekisteröi automaattisesti myös vakiomuotoiset WordPress-lohkot, jotka löytyvät hakemistoistasi Blockstudio. Kaikki block.json, joista puuttuu avain blockstudio mutta joilla on kelvollinen name-ominaisuus, rekisteröidään ominaisuuden WordPress natiivilla register_block_type()-toiminnolla.

Tämä tarkoittaa, että voit sijoittaa @wordpress/create-block-komennolla luodut lohkot suoraan kansioon blockstudio/, jossa ne rekisteröidään automaattisesti muiden lohkojen Blockstudio rinnalle. Erillistä lisäosan rekisteröintikoodia ei tarvita.

Koodi
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

Luo lohkosi komennolla npx wp-scripts build ja siirrä sitten tulostuskansio hakemistoosi Blockstudio. Lohko rekisteröidään automaattisesti.

Sama koskee myös ominaisuuden WordPress 7.0 PHP-pohjaisia lohkoja: block.json, joka sisältää tuen ominaisuudelle autoRegister ja ominaisuuden render.php, ei tarvitse skriptiä eikä koontia, ja lohko rekisteröidään täällä muiden vakiolohkojen tapaan. Ydin rajaa tämän tavan yksinkertaisiin lohkoihin, joiden attribuutit ovat merkkijonoja, kokonaislukuja, totuusarvoja ja enum-arvoja. Jos lohko tarvitsee sisälohkoja, muotoiltua tekstiä, mediaa tai mukautettuja ohjaimia, luo asiakaspuolen lohko tai anna sille avain blockstudio ja käytä edelleen ominaisuutta PHP.

HTML

Blockstudio käyttää React-elementtijäsennintä kuvake-elementin hahmontamiseen, joten kuvakestringissä voi käyttää HTML.

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

Mukautetut polut

Oletuksena Blockstudio etsii rekursiivisesti lohkoja nykyisen teeman tai lapsiteeman kansion blockstudio sisällöstä. Voit muuttaa tätä toimintaa kahdella tavalla.

Suodatin

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

Käytä koostetuissa tai virtuaalisissa tiedostojärjestelmissä loogista hakulähdettä erillisten yläkansion ja peitekerroksen polkujen lisäämisen sijaan. Loogiset lähteet tukevat polkukohtaista peittämistä, perittyjä sisartiedostoja, poistoja, välimuistin tunnistusta ja alkuperätietoja. Katso Loogiset hakulähteet.

Instanssit

Jos yllä olevat vaihtoehdot eivät riitä, voit käynnistää luokan Blockstudio\Build valitsemissasi kansioissa:

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

Suodata metatiedot

Metatiedot voi suodattaa ennen lohkon rekisteröintiä suodattimella 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);

Yllä olevaa esimerkkiä käytetään sisäisesti, jotta kaikilla kirjaston Blockstudio -elementeillä olisi sama kuvake.