Ugrás a tartalomhoz

Bővítmények

A bővítményekkel a WordPress telepítésében regisztrált bármely blokk egyszerű, .json alapú API segítségével bővíthető. Ez a block.json konfigurációhoz hasonló. A funkció a core, harmadik féltől származó és a Blockstudio segítségével készített blokkokra is kiterjed.

Bármely blokkhoz hozzáadhatók mezőtípusok, az adatok pedig a blokk attribútumai közé kerülnek. A bővítményeknél az attribútumok teljes funkciókészlete elérhető: többek között a szűrés, a letiltás, a feltételes logika és a lehetőségek feltöltése.

Bővítménytípusok

A kiterjesztett értékek sokféleképpen felhasználhatók:

  • class: Osztály hozzáadása a blokkhoz az attribútum értékével
  • style: Inline stílusok hozzáadása a blokkhoz az attribútum értékével
  • attributes: Bármely attribútumérték közvetlen beállítása a blokkon
  • data attributes: Kiterjesztési értékek használata meghatározott adatattribútumok beállításához

Beállítás

Képzelje el a következő helyzetet: egyéni osztálymezőt select szeretne hozzáadni minden alapblokkhoz. Ehhez csak adja hozzá ezt a .json fájlt bárhová a blokk mappájában, és a rendszer automatikusan kiterjesztésként regisztrálja.

JSON
{
  "$schema": "https://blockstudio.dev/schema/extend",
  "name": "core/*",
  "priority": 10,
  "blockstudio": {
    "extend": true,
    "attributes": [
      {
        "id": "customColor",
        "type": "select",
        "label": "Custom color",
        "options": [
          {
            "value": "#f00",
            "label": "Red"
          },
          {
            "value": "#00f",
            "label": "Blue"
          }
        ],
        "set": [
          {
            "attribute": "style",
            "value": "color: {attributes.customColor}"
          }
        ]
      }
    ]
  }
}

Ez minden alapblokkhoz hozzáad egy customColor mezőt, amelyben beállíthatja a blokk szövegének színét.

Fájlnév

Mivel nincs megjelenítési sablon, a kiterjesztésnek nincs szüksége hozzá tartozó index fájlra, ezért nem kell block.json névre hallgatnia. Így az összes kiterjesztés kényelmesen tárolható egyetlen mappában. Több fájl is kiterjesztheti ugyanazokat a blokkokat, például két "name": "core/*" fájl; mindegyik a saját mezőit regisztrálja.

Séma

A Blockstudio egyéni JSON sémát biztosít a kiterjesztés-konfigurációkhoz:

Kiterjesztési séma megtekintése

Név

A konfigurációs objektum name tulajdonsága határozza meg, mely blokkokat kell kiterjeszteni. Az igényeitől függően három lehetőség közül választhat:

  • blockName: Egyetlen blokk neve, e.g. core/paragraph
  • [blockNameA, blockNameB]: Blokknevek tömbje, e.g. ["core/paragraph", "core/heading"]
  • core/*: Helyettesítő karakter egy adott típus összes blokkjának kiterjesztéséhez

Minden csillaggal végződő név prefixumként használatos helyettesítő karakter, nem csak a core/*. A következő kiterjesztés minden olyan blokkra érvényes, amelynek neve a my-plugin/ karaktersorozattal kezdődik, beleértve a Blockstudio segítségével létrehozott blokkokat is:

JSON
{
  "name": "my-plugin/*",
  "blockstudio": {
    "extend": true,
    "attributes": []
  }
}

Blokkok kizárása

Használjon legfelső szintű exclude tömböt azoknak a blokkoknak a kihagyására, amelyek egyébként megfelelnének a name feltételnek:

JSON
{
  "$schema": "https://blockstudio.dev/schema/extend",
  "name": "core/*",
  "exclude": ["core/button", "core/image"],
  "blockstudio": {
    "extend": true,
    "attributes": []
  }
}

A kizárásoknál ugyanaz a pontos név szerinti és záró * karakterrel végzett prefixumillesztés érvényes, mint a name esetében. Elsőbbséget élveznek az egyedi nevekkel, névlistákkal és helyettesítő karakterekkel szemben. A kizárt blokk nem kapja meg sem a kiterjesztés szerkesztőmezőit, sem a kezelőfelületi attribútumait vagy erőforrásait. Más, egyező kiterjesztéseket ez nem érint. A meglévő működés megtartásához hagyja el a exclude elemet, vagy használjon üres tömböt.

Blockstudio kulcs

A saját blokkokhoz hasonlóan, ha block.json használ, a konfigurációs objektumnak tartalmaznia kell a blockstudio tulajdonságot, amelynek értéke extend kell legyen: true.

Pozíció

Alapértelmezés szerint a kiterjesztések saját lapon jelennek meg a blokkfelügyelőben. Ha másik pozícióba szeretné áthelyezni őket, használja a group tulajdonságot:

  • settings: Alapértelmezett pozíció
  • styles: Stílusok lap
  • advanced: Speciális lap
JSON
{
  "$schema": "https://blockstudio.dev/schema/extend",
  "name": "core/*",
  "blockstudio": {
    "extend": true,
    "group": "styles",
    "attributes": []
  }
}

Prioritás

A priority tulajdonsággal megadhatja a kiterjesztések megjelenítési sorrendjét. A magasabb prioritású kiterjesztések később jelennek meg. Állítsa be a fájl legfelső szintjén, a beállítási példához hasonlóan, vagy a extend belsejében:

JSON
{
  "$schema": "https://blockstudio.dev/schema/extend",
  "name": "core/*",
  "blockstudio": {
    "extend": { "priority": 10 },
    "attributes": []
  }
}

Ha mindkettő be van állítva, a blockstudio.extend.priority élvez elsőbbséget.

Attribútumok

Az attribútumok működéséről további információt az attribútumok szakaszban talál.

A kiterjesztések attribútumaival kapcsolatban csak a set tulajdonságot kell ismernie. Ezzel rendelheti hozzá az attribútum értékét valamelyik kiterjesztéstípushoz.

JSON
{
  "$schema": "https://blockstudio.dev/schema/extend",
  "name": "core/*",
  "blockstudio": {
    "extend": true,
    "attributes": [
      {
        "id": "customColor",
        "type": "select",
        "label": "Heading color",
        "options": [
          {
            "value": "#f00",
            "label": "Red"
          },
          {
            "value": "#00f",
            "label": "Blue"
          }
        ],
        "set": [
          {
            "attribute": "style",
            "value": "color: {attributes.customColor}"
          }
        ]
      }
    ]
  }
}

Értékek lekérése

Az attribútum értékét kapcsos zárójelek közötti pontozott jelöléssel kérheti le.

Beágyazott értékek is lekérhetők, ha az attribútumok nem egyetlen értéket adnak vissza, például amikor a visszatérési formátumot both értékre állítja a választható értékeket tartalmazó mezőtípusoknál.

JSON
{
  "attributes": [
    {
      "id": "customColor",
      "type": "select",
      "label": "Heading color",
      "options": [
        {
          "value": "#f00",
          "label": "Red"
        },
        {
          "value": "#00f",
          "label": "Blue"
        }
      ],
      "returnFormat": "both",
      "set": [
        {
          "attribute": "style",
          "value": "color: {attributes.customColor.value}"
        },
        {
          "attribute": "data-color",
          "value": "{attributes.customColor.label}"
        }
      ]
    }
  ]
}

A fenti példa az style attribútumot color: #f00 vagy color: #00f, az data-color attribútumot pedig Red vagy Blue értékre állítja be, az értéktől függően.

Egyelőre csak az aktuális attribútum értékei használhatók az set definícióiban. A jövőben lehetővé válhat más attribútumok értékeinek használata is.

Tömbök

Tömbök használatakor a set tulajdonság a tömb minden elemére érvényesül.

Minden elem hozzáadja a saját osztályát vagy stílusdeklarációját. Minden más attribútum egyetlen értéket tárol, ezért minden elem felülírja az előzőt, és az utolsó érték marad érvényben. Állítsa a join értékét true értékre, hogy ehelyett az összes elem eredménye bekerüljön, szóközökkel elválasztva, üres vagy ismétlődő értékek nélkül, így például a [data-langs~="en"] szelektor minden kiválasztott elemre illeszkedik. A join nincs hatással a class és a style elemekre, illetve az egyetlen értéket visszaadó mezőkre.

JSON
{
  "id": "langs",
  "type": "checkbox",
  "label": "Languages",
  "options": [
    {
      "value": "en",
      "label": "English"
    },
    {
      "value": "de",
      "label": "German"
    }
  ],
  "set": [
    {
      "attribute": "data-langs",
      "value": "{attributes.langs}",
      "join": true
    }
  ]
}

Mindkét beállítás kiválasztásakor a data-langs="en de" jelenik meg. A join nélkül a data-langs="de" jelenik meg.

Attribútummező

A attributes mező használatakor nincs szükség set tulajdonságra, mivel a mező automatikusan az attribútum nevéhez és értékéhez rendeli az értékeket.

A kiterjesztés mezőinek vizsgálata

A bs_block_extension_fields('core/paragraph') visszaadja a blokkra illeszkedő összes kiterjesztés meződefinícióit. A visszatérési értékről és annak bs_block_fields()-hoz való viszonyáról az Blokkok vizsgálata című részben olvashat.