Registravimas
Kurti savo blokus naudojant Blockstudio labai paprasta. Įskiepis ieškos aplanko blockstudio šiuo metu aktyvioje temoje. Jame bus registruoti visi poaplankiai, kuriuose yra failas block.json su raktu blockstudio.
block.json
{
"name": "blockstudio/native",
"title": "Native Block",
"category": "text",
"icon": "star-filled",
"description": "Native Blockstudio block.",
"blockstudio": true
}
Šablonas
Kol kas tinkintas blokas nebus registruotas, nes jam trūksta šablono. Norėdami tai ištaisyti, tiesiog sukurkite index.php tame pačiame aplanke kaip failas block.json; jo turinys bus automatiškai atvaizduojamas naudojant jūsų bloką.
<h1>My first native block.</h1>
Sąlyginė logika
Blokus galima registruoti sąlygiškai naudojant raktą conditions. Jis palaiko visus visuotinius kintamuosius, kurie taip pat pasiekiami atributams.
Toliau pateiktame pavyzdyje blokas bus registruojamas tik tada, jei dabartinio įrašo tipas yra puslapis:
{
"blockstudio": {
"conditions": [
[
{
"type": "postType",
"operator": "==",
"value": "page"
}
]
]
}
}
Įskiepių priklausomybės
Blokai gali priklausyti nuo aktyvių WordPress įskiepių naudojant raktą pluginDependencies. Jei kuris nors iš išvardytų įskiepių neaktyvus, blokas registruojant praleidžiamas.
Priklausomybėms naudojami WordPress įskiepių trumpieji vardai:
{
"blockstudio": {
"pluginDependencies": [
"woocommerce",
"advanced-custom-fields"
]
}
}
Norėdami reikalauti konkrečios įskiepio versijos, naudokite objekto formą. Versijų apribojimams taikomi tie patys operatoriai kaip PHP ypatybei version_compare(); versija be operatoriaus laikoma >=.
{
"blockstudio": {
"pluginDependencies": {
"woocommerce": {
"version": ">6"
}
}
}
}
Tinkinta piktograma
Tinkintas blokų SVG piktogramas galima registruoti taip:
{
"blockstudio": {
"icon": "<svg></svg>"
}
}
WordPress neleidžia savo block.json icon rakte naudoti tinkintų SVG piktogramų; čia leidžiami tik Dashicons ID.
Standartiniai WordPress blokai
Blockstudio taip pat automatiškai registruoja standartinius WordPress blokus, rastus kataloguose Blockstudio. Bet kuris block.json be rakto blockstudio, bet turintis galiojančią ypatybę name, registruojamas naudojant savąją register_block_type() iš WordPress.
Tai reiškia, kad galite įdėti blokus, paruoštus naudojant @wordpress/create-block, tiesiai į aplanką blockstudio/ ir jie bus automatiškai užregistruoti kartu su jūsų Blockstudio blokais. Atskiro įskiepio registravimo kodo nereikia.
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
Sukurkite bloką naudodami npx wp-scripts build, tada įdėkite išvesties aplanką į katalogą Blockstudio. Blokas bus užregistruotas automatiškai.
Tas pats taikoma ir WordPress 7.0 PHPtik klientui skirtiems blokams:
block.json su autoRegister palaikymu ir render.php nereikalauja scenarijaus ar kūrimo etapo ir čia registruojami kaip bet kuris kitas standartinis blokas. Pagrindinė sistema šį kelią taiko tik paprastiems blokams, kurių atributai yra eilutės, sveikieji skaičiai, loginės reikšmės ar išvardijimo reikšmės. Jei reikia vidinių blokų, raiškiojo teksto, medijos ar tinkintų valdiklių, sukurkite kliento pusės bloką arba nurodykite raktą blockstudio ir naudokite PHP.
HTML
Blockstudio piktogramos elementui atvaizduoti naudoja React elementų analizatorių, todėl piktogramos eilutėje galima naudoti HTML.
{
"blockstudio": {
"icon": "<div>:-)</div>"
}
}
Tinkinti keliai
Pagal numatytuosius nustatymus Blockstudio rekursyviai ieškos blokų aplanke blockstudio dabartinėje temoje arba antrinėje temoje. Šį veikimą galite pakeisti dviem būdais.
Filtras
// 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';
});
Sudėtinėms arba virtualioms failų sistemoms naudokite loginį aptikimo šaltinį, užuot pridėję atskirus pirminio aplanko ir perdangos kelius. Loginiai šaltiniai palaiko kiekvieno kelio uždengimą, paveldimus gretimus failus, trynimus, talpyklos tapatybę ir kilmės informaciją. Žr. Loginiai aptikimo šaltiniai.
Egzemplioriai
Jei pirmiau pateiktų parinkčių nepakanka, klasę Blockstudio\Build galima sukurti pasirinktame aplankų rinkinyje:
add_action('init', function () {
Blockstudio\Build::init([
'dir' => get_template_directory() . '/client-blocks'
]);
});
Metaduomenų filtravimas
Metaduomenis galima filtruoti prieš registruojant bloką, naudojant filtrą blockstudio/blocks/meta:
add_filter('blockstudio/blocks/meta', function ($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
Pirmiau pateiktas pavyzdys viduje naudojamas tam, kad visiems bibliotekos Blockstudio elementams būtų priskirta ta pati piktograma.