Първи стъпки
Това ръководство ще ви помогне да настроите Blockstudio и да създадете първия си персонализиран блок.
Инсталиране
Чрез Composer (препоръчително)
composer require blockstudio/blockstudio
Blockstudio може да се инсталира като разширение чрез composer/installers или да се включи директно в тема. Вижте документацията на Composer за всички начини на инсталиране.
Инсталациите на Composer получават актуализации чрез Composer. Вграденият инструмент за актуализиране на GitHub се деактивира автоматично.
Ръчно инсталиране
Изтеглете най-новата версия от GitHub
Качете zip файла в директорията за разширения на WordPress и активирайте разширението. Ръчно инсталираните версии получават автоматични известия за актуализации в таблото на WordPress чрез вградения инструмент за актуализиране на GitHub.
И двата метода за инсталиране включват частни копия на библиотеките Markdown, YAML и за актуализиране, както и техните зависимости. Те не използват и не заменят версии, предоставени от друг плъгин или тема. Инсталирайте собствена зависимост Composer, ако приложението ви използва директно някоя от тези библиотеки; включените копия на Blockstudio са вътрешни и не са публичен PHP API.
Проверки за актуализации с удостоверяване
Ръчните инсталации проверяват GitHub анонимно по подразбиране. Няколко сайта, споделящи един изходящ IP, могат да изчерпят анонимния лимит на GitHub за API и да получават 403 отговори от HTTP при проверка за актуализации. От 7.7.4 конфигурирайте личен токен за достъп до GitHub в wp-config.php, преди да се зареди WordPress:
define('BLOCKSTUDIO_GITHUB_TOKEN', 'your-github-token');
Токенът се нуждае само от достъп до информация за публични хранилища. Не предоставяйте права за запис. Съхранявайте го в сървърната конфигурация, извън системата за контрол на версиите, blockstudio.json, атрибутите на блоковете и кода на фронтенда. За проверки с удостоверяване и изтегляне на версии актуализаторът го предава на включения клиент GitHub. Заявките към несвързани хранилища и други хостове за изтегляне не получават токена.
За тайни, управлявани чрез средата, MU плъгин може да предостави или замени токена:
<?php
add_filter('blockstudio/updater/token', function ($token) {
return getenv('BLOCKSTUDIO_GITHUB_TOKEN') ?: $token;
});
Филтърът се изпълнява, когато Blockstudio инициализира своя актуализатор, преди темата да се зареди. Регистрирайте го в MU плъгин, а не в functions.php. Връщането на празен низ изключва удостоверяването, дори когато константата е дефинирана. Празните стойности или стойности, които не са низове, оставят проверките анонимни. Токените са незадължителни; без такъв текущото поведение при актуализация остава непроменено. Инсталациите на Composer продължават да използват Composer за актуализации и не инициализират този актуализатор.
Създаване на първия ви блок
1. Създайте директория за блока
Създайте нова директория в темата си:
my-theme/
blockstudio/
my-first-block/
block.json
index.php
2. Дефинирайте схемата на блока
Създайте block.json с конфигурацията на блока:
{
"$schema": "https://blockstudio.dev/schema/block",
"name": "my-theme/my-first-block",
"title": "My First Block",
"category": "common",
"icon": "star-filled",
"blockstudio": {
"attributes": [
{
"id": "heading",
"type": "text",
"label": "Heading",
"default": "Hello World"
},
{
"id": "content",
"type": "textarea",
"label": "Content"
}
]
}
}
3. Създайте шаблона
Създайте index.php за визуализиране:
<div class="my-first-block">
<h2><?php echo $a['heading']; ?></h2>
<p><?php echo $a['content']; ?></p>
</div>
Използване на шаблони Twig
Blockstudio поддържа шаблони Twig по подразбиране. Просто използвайте index.twig вместо това:
<div class="my-first-block">
<h2>{{ a.heading }}</h2>
<p>{{ a.content }}</p>
</div>
Добавяне на стилове
Създайте файл style.css в същата папка:
.my-first-block {
padding: 2rem;
background: #f5f5f5;
}
Blockstudio автоматично ще добави този стилов файл в опашката за зареждане, когато блокът се използва.
Преводи
Контролите в редактора и административният преглед на Blockstudio зареждат преводите на JavaScript за текстовия домейн blockstudio чрез WordPress. Инсталирайте съответния езиков пакет или генерирайте файлове JSON със скриптов превод чрез инструмента си за превод в wp-content/languages/plugins/. Низовете без наличен превод остават на английски. Това превежда собствения интерфейс на Blockstudio, а не съдържанието или етикетите на полетата, които дефинирате в блоковете си.
Следващи стъпки
Блокът ви вече е готов за използване в редактора WordPress. Продължете да разглеждате документацията, за да научите повече за:
- Типове полета — всички налични типове полета
- Компоненти — InnerBlocks, RichText и други
- Интеграция с Tailwind — използване на Tailwind CSS
- Hooks — разширяване на функционалността с филтри и действия
Създаване на библиотека с блокове
Преминете от единичен блок към цяла библиотека: дизайн токени, шаблон за секции, повторители, изображения и композиция на страници.