Перейти до вмісту

Початок роботи

Цей посібник допоможе вам налаштувати Blockstudio і створити свій перший користувацький блок.

Встановлення

Командна оболонка
composer require blockstudio/blockstudio

Blockstudio можна встановити як плагін через composer/installers або безпосередньо включити до теми. У документації описано всі способи встановлення.Composer

Оновлення встановлень Composer надходять через Composer. Вбудований засіб оновлення GitHub автоматично вимикається.

Встановлення вручну

Завантажте останню версію з GitHub

Завантажте ZIP-архів у каталог плагінів WordPress і активуйте плагін. Для встановлень вручну сповіщення про оновлення надходять автоматично в панель керування WordPress через вбудований засіб оновлення GitHub.

Обидва способи встановлення містять приватні копії бібліотек Markdown, YAML та оновлення, а також їхні залежності. Вони не використовують і не замінюють версії, надані іншими плагінами чи темами. Якщо ваш застосунок безпосередньо використовує одну з цих бібліотек, установіть власну залежність Composer; вбудовані копії Blockstudio є внутрішніми, а не загальнодоступним PHP API.

Перевірка оновлень з автентифікацією

За замовчуванням ручні встановлення перевіряють GitHub анонімно. Кілька сайтів зі спільним вихідним IP можуть вичерпати ліміт анонімних API для GitHub і отримувати відповіді HTTP 403 під час перевірки оновлень. У 7.7.4 налаштуйте персональний токен доступу GitHub у wp-config.php до завантаження WordPress:

PHP
define('BLOCKSTUDIO_GITHUB_TOKEN', 'your-github-token');

Токену потрібен доступ лише до загальнодоступної інформації репозиторію. Не надавайте дозволів на запис. Зберігайте його в серверній конфігурації, поза системою контролю версій і поза blockstudio.json, атрибутами блоків і кодом фронтенду. Засіб оновлення передає його своєму вбудованому клієнту GitHub для автентифікованих перевірок і завантаження релізів. Запити до сторонніх репозиторіїв та інших хостів завантаження не отримують токен.

Для секретів, що керуються середовищем, MU-плагін може надати токен або замінити його:

PHP
<?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 із конфігурацією блоку:

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 для рендерингу:

PHP
<div class="my-first-block">
  <h2><?php echo $a['heading']; ?></h2>
  <p><?php echo $a['content']; ?></p>
</div>

Використання шаблонів Twig

Blockstudio підтримує шаблони Twig одразу після встановлення. Просто використовуйте index.twig:

Twig
<div class="my-first-block">
  <h2>{{ a.heading }}</h2>
  <p>{{ a.content }}</p>
</div>

Додавання стилів

Створіть файл style.css у тій самій папці:

CSS
.my-first-block {
  padding: 2rem;
  background: #f5f5f5;
}

Blockstudio автоматично додасть цю таблицю стилів до черги завантаження, коли використовуватиметься блок.

Переклади

У редакторі Blockstudio та огляді адміністратора завантажуються переклади JavaScript для текстового домену blockstudio через WordPress. Установіть відповідний мовний пакет або створіть файли перекладів скриптів JSON за допомогою інструмента перекладу в wp-content/languages/plugins/. Рядки, для яких немає перекладу, залишаються англійською. Це перекладає власний інтерфейс Blockstudio, а не вміст чи мітки полів, які ви задаєте у своїх блоках.

Наступні кроки

Тепер ваш блок готовий до використання в редакторі WordPress. Продовжуйте вивчати документацію, щоб дізнатися про:

Створення бібліотеки блоків

Перейдіть від одного блоку до повноцінної бібліотеки: токени дизайну, шаблон секції, повторювані поля, зображення та компонування сторінок.