Регистриране
Създаването на собствени блокове с Blockstudio е изключително лесно. Плъгинът
търси папка blockstudio в активната в момента тема. Всички подпапки в нея,
които съдържат файл block.json с ключ blockstudio, ще бъдат регистрирани.
block.json
{
"name": "blockstudio/native",
"title": "Native Block",
"category": "text",
"icon": "star-filled",
"description": "Native Blockstudio block.",
"blockstudio": true
}
Шаблон
Засега персонализираният блок няма да бъде регистриран, защото му липсва
шаблон. За да го добавите, създайте index.php в същата папка като файла
block.json. Съдържанието му ще се изобразява автоматично при използване на блока.
<h1>My first native block.</h1>
Условна логика
Блоковете могат да се регистрират условно чрез ключа conditions. Той поддържа
всички глобални променливи, налични и за атрибутите.
Следващият пример регистрира блока само ако текущият тип публикация е страница:
{
"blockstudio": {
"conditions": [
[
{
"type": "postType",
"operator": "==",
"value": "page"
}
]
]
}
}
Зависимости от плъгини
Блоковете могат да зависят от активни плъгини WordPress чрез ключа pluginDependencies.
Ако някой от посочените плъгини е неактивен, блокът се пропуска при
регистрирането.
За зависимостите се използват идентификаторите на плъгините WordPress:
{
"blockstudio": {
"pluginDependencies": [
"woocommerce",
"advanced-custom-fields"
]
}
}
Използвайте формата с обект, за да зададете задължителна версия на плъгина. Ограниченията за версии използват
същите оператори като version_compare() на PHP; версия без оператор се
приема за >=.
{
"blockstudio": {
"pluginDependencies": {
"woocommerce": {
"version": ">6"
}
}
}
}
Персонализирана икона
Персонализирани SVG икони за блокове могат да се регистрират така:
{
"blockstudio": {
"icon": "<svg></svg>"
}
}
WordPress не позволява персонализирани SVG икони в собствения си ключ block.json icon; тук са разрешени само идентификатори на
Dashicons.
Стандартни блокове WordPress
Blockstudio регистрира автоматично и стандартните блокове WordPress в директориите Blockstudio. Всеки block.json без ключ blockstudio, но с валидно свойство name, се регистрира чрез вградения register_block_type() на WordPress.
Това означава, че можете да поставите блокове, подготвени с @wordpress/create-block,
директно в папката blockstudio/ и те ще бъдат регистрирани автоматично
заедно с блоковете Blockstudio. Не е необходим отделен код за регистриране на плъгина.
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
Създайте блока си с npx wp-scripts build, а след това поставете изходната папка в
директорията Blockstudio. Блокът ще бъде регистриран автоматично.
Същото важи и за блоковете PHP на WordPress 7.0:
block.json с поддръжка на autoRegister и render.php не се нуждае от скрипт или компилация и се регистрира тук като всеки друг стандартен блок. Core ограничава този подход до прости блокове с атрибути от тип string, integer, boolean и enum; щом са нужни вътрешни блокове, форматиран текст, медия или персонализирани контроли, създайте блок от страна на клиента или му задайте ключ blockstudio и останете в PHP.
HTML
Blockstudio използва парсер за елементи React, за да изобрази елемента на иконата, така че е възможно да използвате HTML в низа на иконата.
{
"blockstudio": {
"icon": "<div>:-)</div>"
}
}
Персонализирани пътища
По подразбиране Blockstudio търси рекурсивно блокове в папката blockstudio
на текущата тема или дъщерната тема. Можете да промените това по два начина.
Филтър
// 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';
});
За съставни или виртуални файлови системи използвайте логически източник за откриване, вместо да добавяте отделни пътища за родител и наслагване. Логическите източници поддържат засенчване по път, наследяване на съседни файлове, изтривания, идентичност на кеша и проследяване на произхода. Вижте Логически източници за откриване.
Инстанции
Ако горните опции не са достатъчни, можете да създадете инстанция на класа
Blockstudio\Build за избрани от вас папки:
add_action('init', function () {
Blockstudio\Build::init([
'dir' => get_template_directory() . '/client-blocks'
]);
});
Филтриране на метаданни
Метаданните могат да се филтрират преди регистрирането на блока чрез
филтъра 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);
Горният пример се използва вътрешно, за да зададе една и съща икона на всички елементи от библиотеката Blockstudio.