Paplašinājumi
Paplašinājumi ļauj paplašināt jebkuru reģistrētu bloku jūsu WordPress instalācijā, izmantojot vienkāršu .json balstītu API, kas līdzinās block.json konfigurācijai. Tas attiecas uz kodola, trešo pušu un ar Blockstudio veidotiem blokiem.
Jebkuram blokam var pievienot visu veidu laukus, un dati tiek saglabāti bloka atribūtos. Paplašinājumos pieejams pilns atribūtu funkciju klāsts, tostarp filtrēšana, atspējošana, nosacījumu loģika un opciju aizpildīšana.
Paplašinājumu veidi
Paplašinātās vērtības var izmantot dažādos veidos:
- class: pievienojiet blokam klasi, izmantojot atribūta vērtību
- style: pievienojiet blokam iekļautos stilus, izmantojot atribūta vērtību
- attributes: iestatiet jebkuru atribūta vērtību tieši blokā
- data attributes: izmantojiet paplašinājumu vērtības, lai iestatītu konkrētus datu atribūtus
Iestatīšana
Iedomājieties šādu situāciju: vēlaties katram pamata blokam pievienot pielāgotu klases select lauku. Jums tikai jāpievieno šis .json fails jebkurā vietā bloka mapē, un tas tiks automātiski reģistrēts kā paplašinājums.
{
"$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}"
}
]
}
]
}
}
Tādējādi katram pamata blokam tiks pievienots customColor lauks, kas ļaus iestatīt bloka teksta krāsu.
Faila nosaukums
Tā kā renderēšanas veidnes nav, paplašinājumam nav nepieciešams atbilstošs index fails, un tāpēc tam nav jābūt nosauktam block.json. Tas ļauj ērti glabāt visus paplašinājumus vienā mapē. Vairāki faili var paplašināt vienus un tos pašus blokus, piemēram, divi faili ar "name": "core/*"; katrs reģistrē savus laukus.
Shēma
Blockstudio nodrošina pielāgotu JSON shēmu paplašinājumu konfigurācijām:
Nosaukums
Konfigurācijas objekta rekvizīts name nosaka, kuri bloki jāpaplašina. Atkarībā no vajadzībām ir pieejamas trīs iespējas:
- blockName: viena bloka nosaukums, e.g.
core/paragraph - [blockNameA, blockNameB]: bloku nosaukumu masīvs, e.g.
["core/paragraph", "core/heading"] - core/*: aizstājējzīme visu noteikta veida bloku paplašināšanai
Jebkurš nosaukums, kas beidzas ar zvaigznīti, ir prefiksa aizstājējzīme, ne tikai core/*. Tālāk norādītais paplašinājums attiecas uz katru bloku, kura nosaukums sākas ar my-plugin/, tostarp blokiem, kas izveidoti ar Blockstudio:
{
"name": "my-plugin/*",
"blockstudio": {
"extend": true,
"attributes": []
}
}
Bloku izslēgšana
Izmantojiet augstākā līmeņa masīvu exclude, lai izlaistu blokus, kas citādi atbilstu name:
{
"$schema": "https://blockstudio.dev/schema/extend",
"name": "core/*",
"exclude": ["core/button", "core/image"],
"blockstudio": {
"extend": true,
"attributes": []
}
}
Izslēgšanas gadījumā tiek izmantota tā pati precīzā nosaukuma un beigu * prefiksa atbilstība kā name gadījumā. Tām ir priekšroka salīdzinājumā ar atsevišķiem nosaukumiem, nosaukumu sarakstiem un aizstājējzīmēm. Izslēgtais bloks nesaņem ne paplašinājuma redaktora laukus, ne tā priekšgala atribūtus vai resursus. Citi atbilstošie paplašinājumi netiek ietekmēti. Lai saglabātu esošo darbību, izlaidiet exclude vai izmantojiet tukšu masīvu.
Atslēga Blockstudio
Tāpat kā izmantojot block.json pielāgotiem blokiem, konfigurācijas objektā jābūt rekvizītam blockstudio, kura vērtība iestatīta uz true ar extend.
Novietojums
Pēc noklusējuma paplašinājumi bloka inspektorā tiek rādīti savā cilnē. Ja vēlaties pārvietot paplašinājumus citur, varat izmantot rekvizītu group:
- settings: noklusējuma novietojums
- styles: stilu cilne
- advanced: papildu iestatījumu cilne
{
"$schema": "https://blockstudio.dev/schema/extend",
"name": "core/*",
"blockstudio": {
"extend": true,
"group": "styles",
"attributes": []
}
}
Prioritāte
Rekvizīts priority ļauj noteikt paplašinājumu attēlošanas secību. Paplašinājumi ar augstāku prioritāti tiks attēloti vēlāk. Iestatiet to faila augšējā līmenī, kā iestatīšanas piemērā, vai iekšpusē extend:
{
"$schema": "https://blockstudio.dev/schema/extend",
"name": "core/*",
"blockstudio": {
"extend": { "priority": 10 },
"attributes": []
}
}
Ja iestatītas abas vērtības, priekšroka ir blockstudio.extend.priority.
Atribūti
Plašāku informāciju par atribūtu darbību skatiet atribūtu sadaļā.
Vienīgais, kas jāzina par atribūtiem paplašinājumos, ir rekvizīts set. To izmanto, lai piešķirtu atribūta vērtību kādam no paplašinājuma veidiem.
{
"$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}"
}
]
}
]
}
}
Vērtību iegūšana
Lai iegūtu atribūta vērtību, figūriekavās izmanto punktu pierakstu.
Ja atribūti neatgriež vienu vērtību, iespējams iegūt arī ligzdotas vērtības, piemēram, iestatot atgriešanas formātu uz both lauku tipiem ar izvēles iespējām.
{
"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}"
}
]
}
]
}
Iepriekš minētais piemērs iestatīs atribūtu style uz color: #f00 vai color: #00f un atribūtu data-color uz Red vai Blue atkarībā no vērtības.
Pagaidām definīcijās set var izmantot tikai pašreizējā atribūta vērtības. Iespēja izmantot citu atribūtu vērtības varētu tikt pievienota nākotnē.
Masīvi
Izmantojot masīvus, rekvizīts set tiks piemērots katram masīva elementam.
Katrs vienums pievieno savu klasi vai stila deklarāciju. Katram citam atribūtam ir viena vērtība, tāpēc katrs vienums to pārraksta un uzvar pēdējais. Iestatiet join uz true, lai tā vietā ierakstītu visu vienumu rezultātus, atdalītus ar atstarpēm un bez tukšām vai atkārtotām vērtībām, tādējādi atlasītājs, piemēram, [data-langs~="en"], atbilst katram atlasītajam vienumam. join neietekmē class un style, kā arī laukus, kas atgriež vienu vērtību.
{
"id": "langs",
"type": "checkbox",
"label": "Languages",
"options": [
{
"value": "en",
"label": "English"
},
{
"value": "de",
"label": "German"
}
],
"set": [
{
"attribute": "data-langs",
"value": "{attributes.langs}",
"join": true
}
]
}
Izvēloties abas opcijas, tiek renderēts data-langs="en de". Bez join tiek renderēts data-langs="de".
Atribūtu lauks
Izmantojot lauku attributes, rekvizīts set nav vajadzīgs, jo lauks automātiski piesaista vērtības atribūta nosaukumam un vērtībai.
Paplašinājuma lauku pārbaude
bs_block_extension_fields('core/paragraph') atgriež to paplašinājumu lauku definīcijas, kas atbilst blokam. Atgriežamo vērtību un tās saistību ar bs_block_fields() skatiet sadaļā Bloku pārbaude.