Registrace
Vytváření vlastních bloků pomocí Blockstudio je velmi snadné. Plugin vyhledá složku blockstudio v aktuálně aktivovaném motivu. Zaregistrují se všechny její podsložky, které obsahují soubor block.json s klíčem blockstudio.
block.json
{
"name": "blockstudio/native",
"title": "Native Block",
"category": "text",
"icon": "star-filled",
"description": "Native Blockstudio block.",
"blockstudio": true
}
Šablona
Vlastní blok zatím nebude zaregistrován, protože mu chybí šablona. Opravíte to tak, že ve stejné složce jako soubor block.json vytvoříte index.php. Jeho obsah se pak automaticky vykreslí při použití bloku.
<h1>My first native block.</h1>
Podmíněná logika
Bloky lze registrovat podmíněně pomocí klíče conditions. Podporuje všechny globální proměnné dostupné také pro atributy.
Následující příklad zaregistruje blok pouze v případě, že aktuálním typem příspěvku je stránka:
{
"blockstudio": {
"conditions": [
[
{
"type": "postType",
"operator": "==",
"value": "page"
}
]
]
}
}
Závislosti na pluginech
Bloky mohou záviset na aktivních pluginech WordPress pomocí klíče pluginDependencies. Pokud některý z uvedených pluginů není aktivní, blok se při registraci přeskočí.
Závislosti používají označení pluginů WordPress:
{
"blockstudio": {
"pluginDependencies": [
"woocommerce",
"advanced-custom-fields"
]
}
}
K nastavení požadované verze pluginu použijte objektovou podobu. Omezení verzí používají stejné operátory jako version_compare() v PHP; verze bez operátoru se považuje za >=.
{
"blockstudio": {
"pluginDependencies": {
"woocommerce": {
"version": ">6"
}
}
}
}
Vlastní ikona
Vlastní ikony SVG pro bloky lze registrovat například takto:
{
"blockstudio": {
"icon": "<svg></svg>"
}
}
WordPress nepovoluje vlastní ikony SVG ve vlastním klíči block.json icon; povolena jsou pouze ID Dashicons.
Standardní bloky WordPress
Blockstudio také automaticky registruje standardní bloky WordPress nalezené ve vašich adresářích Blockstudio. Každý block.json bez klíče blockstudio, ale s platnou vlastností name, se zaregistruje pomocí nativní funkce register_block_type() v WordPress.
Bloky vytvořené pomocí @wordpress/create-block tak můžete umístit přímo do složky blockstudio/. Automaticky se zaregistrují spolu s vašimi bloky Blockstudio, bez nutnosti samostatného registračního kódu pluginu.
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
Vytvořte blok pomocí npx wp-scripts build a poté vložte výstupní složku do adresáře Blockstudio. Blok se zaregistruje automaticky.
Totéž platí pro bloky WordPress 7.0, které používají pouze PHP bloky:
block.json s podporou autoRegister a render.php nevyžadují skript ani sestavení a registrují se zde jako jakýkoli jiný standardní blok. Core omezuje tuto cestu na jednoduché bloky s atributy typu řetězec, celé číslo, boolean a enum; jakmile potřebujete vnitřní bloky, formátovaný text, média nebo vlastní ovládací prvky, vytvořte klientský blok nebo mu přidělte klíč blockstudio a zůstaňte v PHP.
HTML
Blockstudio k vykreslení prvku ikony používá analyzátor prvků React, takže lze uvnitř řetězce ikony použít HTML.
{
"blockstudio": {
"icon": "<div>:-)</div>"
}
}
Vlastní cesty
Ve výchozím nastavení Blockstudio rekurzivně prohledává složku blockstudio v aktuálním motivu nebo jeho podřízeném motivu a hledá v ní bloky. Toto chování můžete změnit dvěma způsoby.
Filtr
// 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';
});
U složených nebo virtuálních souborových systémů použijte logický zdroj pro vyhledávání místo přidávání samostatných cest k nadřazené a překryvné vrstvě. Logické zdroje podporují překrývání cest, dědění souborů ze stejných složek, mazání, identitu mezipaměti a informace o původu. Viz Logické zdroje pro vyhledávání.
Instance
Pokud výše uvedené možnosti nestačí, můžete inicializovat třídu
Blockstudio\Build v libovolných složkách:
add_action('init', function () {
Blockstudio\Build::init([
'dir' => get_template_directory() . '/client-blocks'
]);
});
Filtrování metadat
Metadata lze před registrací bloku filtrovat pomocí filtru
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);
Výše uvedený příklad se interně používá k přiřazení stejné ikony všem prvkům knihovny Blockstudio.