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

CLI

Blockstudio реєструє команди WP-CLI для керування блоками, сторінками у файлах, записами бази даних, функціями RPC, завданнями cron, налаштуваннями та мовною конфігурацією WPML із термінала.

Блоки

Перелік усіх блоків

Командна оболонка
wp bs blocks list
Код
+----------------------------+---------------------+-----------+------------------------+
| name                       | title               | component | category               |
+----------------------------+---------------------+-----------+------------------------+
| my-theme/hero              | Hero                |           | my-theme               |
| my-theme/card              | Card                | yes       | my-theme               |
| my-theme/newsletter        | Newsletter          |           | my-theme               |
+----------------------------+---------------------+-----------+------------------------+

Фільтрування лише за компонентами

Командна оболонка
wp bs blocks list --components

Виведення у форматі JSON

Командна оболонка
wp bs blocks list --format=json

Перевірка збережених полів

Командна оболонка
wp bs blocks validate 42
wp bs blocks validate 42 57 --format=json

Перевіряє збережений вміст указаних ID записів, зокрема вкладені innerBlocks, за допомогою bs_validate_block(). Команда не відображає блоки, не розгортає посилання на синхронізовані шаблони й не змінює записи. Невідомі блоки без розширень Blockstudio пропускаються.

У таблиці за замовчуванням зазначено ID запису, індексований від нуля шлях до блока, назву блока, код проблеми, шлях до поля, джерело й повідомлення. JSON також містить вихідні значення value і expected. Вкладений блок може мати шлях до блока 0/1 і шлях до поля cards/2/style; це окремі шляхи.

Команда завершується з кодом 0, якщо проблем не знайдено, і 1, якщо їх знайдено. Вивід JSON — це звичайний список, у якому [] є навіть за успішного виконання, тож засоби автоматизації можуть його зчитати, навіть коли команда завершується з кодом 1. Відсутні записи, відсутні ID та формати, крім table або json, спричиняють помилку. Усі ID перевіряються до початку перевірки.

Відображення блоків

Командна оболонка
wp bs blocks render
wp bs blocks render my-theme/hero my-theme/card
wp bs blocks render my-theme/card --attributes='{"variant":"wide"}'
wp bs blocks render my-theme/card --attributes=@card.json --format=json

Відображає зареєстровані блоки так само, як сторінка, і повідомляє про кожне сповіщення PHP, попередження, застарілий елемент і помилку, що виникла в їхніх шаблонах. Тема може запускати цю команду в CI, щоб перевірити працездатність своїх блоків із встановленим Blockstudio. Якщо назви не вказано, відображаються всі зареєстровані блоки, зокрема компоненти.

Кожен блок відображається через do_blocks() з коментаря блока з blockstudio.attributes — структурою, яку зберігає редактор, — у фронтенд-контексті WP-CLI, а не в попередньому перегляді вставника. Для відображення не налаштовується жоден допис, отриманий запитом. Динамічні острови відображають справжнє тіло шаблону, а не лише заповнювач, а побічний вивід шаблонів не потрапляє до звіту.

Сама команда не зберігає дописи чи значення полів, але виконує ваші шаблони й хуки відображення як звичайні PHP. Вони можуть записувати дані, викликати зовнішні сервіси або спричиняти інші побічні ефекти. Запускайте її на довіреному коді на окремому тестовому сайті; це не середовище ізольованого запуску лише для читання.

Атрибути для відображення вибираються окремо для кожного блока:

Випадок Атрибути
example example.attributes блока block.json — значення, які використовує попередній перегляд у вставнику.
defaults default кожного поля. Використовується для блоків без example.attributes; команда виводить окремий рядок для кожного поля.
attributes Значення --attributes, що замінюють приклад.

--attributes приймає об’єкт JSON зі значеннями полів, де ключами є ключі сховища, або @ і шлях до файлу, який містить такий об’єкт. Потрібно вказати рівно одну назву блока. Використовуйте цю команду, щоб перевірити гілки шаблону, яких немає в прикладі, наприклад варіант. Приклади значень, які створюють лише зображення-заповнювачі в попередньому перегляді вставника, пропускаються, а innerBlocks прикладу не відображаються.

Код
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| block               | case     | level      | message                                                                       | file                                                                         | line |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| smoke/deprecated    | defaults | Deprecated | strlen(): Passing null to parameter #1 ($string) of type string is deprecated | /wordpress/wp-content/themes/smoke-theme/blockstudio/deprecated/index.php    | 1    |
| smoke/undefined-key | example  | Warning    | Undefined array key "subtitle"                                                | /wordpress/wp-content/themes/smoke-theme/blockstudio/undefined-key/index.php | 2    |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+

У таблиці для кожної проблеми наведено окремий рядок. Вивід JSON містить список із записом для кожного відображеного блока, навіть якщо проблем немає, тож засоби автоматизації можуть зчитати використаний випадок:

JSON
[
  {
    "block": "smoke/branch",
    "case": "attributes",
    "problems": [
      {
        "level": "Warning",
        "message": "Undefined array key \"width\"",
        "file": "/wordpress/wp-content/themes/smoke-theme/blockstudio/branch/index.php",
        "line": 2
      }
    ]
  }
]

level — це Notice, Warning, Deprecated або Error. Проблема, що повторюється в тому самому файлі й рядку, наприклад у циклі, звітується один раз для кожного блока. Проблеми, приховані за допомогою @, не звітуються. WordPress створює власні сповіщення про застарілі елементи, наприклад для _deprecated_function(), лише коли ввімкнено WP_DEBUG.

Команда завершується з кодом 0, якщо проблем не знайдено, і з кодом 1 — в іншому разі. Невідомі назви блоків, недоступний для читання або некоректний --attributes, а також формати, крім table або json, спричиняють помилку. Усі назви перевіряються до відображення першого блока.

Сторінки

Синхронізація сторінок із файлами виконується явно. Звичайні запити WordPress ніколи не виконують повне виявлення сторінок і не записують публікації сторінок. Під час холодного запуску середовище виконання може один раз прочитати маніфести колекцій, щоб відновити маршрути, не синхронізуючи вміст.

Командна оболонка
wp bs pages sync

Команда звіряє повний перелік бажаного стану й повідомляє про виявлені, створені, оновлені, незмінені, заблоковані, збережені та видалені сторінки, а також про сторінки, обробку яких не вдалося виконати. За однакових відбитків не записуються дописи чи метадані дописів.

У таблиці змінені, заблоковані, збережені без змін і видалені сторінки зазначено разом з їхніми ID дописів. JSON містить записи pages.<name>.preserved, pages.<name>.overwritten і removedPages із назвою сторінки, ключем, ID допису та дією очищення. Якщо після злиття за ключами допис не змінився, він позначається як незмінений: нова редакція не створюється, а час зміни не оновлюється.

Наявні статуси публікації зберігаються; заміни заголовка й короткого посилання, задані файлом, виводяться як попередження. Див. Власність полів допису.

Використовуйте --authoritative, щоб замінити керований вміст замість збереження вмісту редактора за ключем, а --full — щоб позначити прохід як повне звіряння незалежно від збереженої ідентичності джерела. У будь-якому разі кожен прохід порівнює повний перелік:

Командна оболонка
wp bs pages sync --authoritative --full

Для сценаріїв розгортання, яким потрібен повний звіт:

Командна оболонка
wp bs pages sync --format=json

Для кожної сторінки, яку розбирає команда, перевіряються атрибути, які зберігають її блоки, але ніколи не відображають: атрибути, які блок Blockstudio ані оголошує як поле, ані передає кореневому елементу, наприклад неоголошений class. У табличному виведенні для кожної сторінки й блока друкується попередження, стовпець dropped підраховує їх, а у звіті JSON вони наведені в розділі pages.<name>.droppedAttributes. Сторінки, джерело яких не змінилося, не розбираються повторно, тому вони з’являться у звіті після наступної зміни або під час першої синхронізації після оновлення, що змінює аналізатор.

Команда завершується невдало, якщо під час виявлення або звіряння виникла помилка. Див. Сторінки, щоб дізнатися про PHP API та умови ідентифікації розгортання.

База даних

Перелік схем

Командна оболонка
wp bs db schemas
Код
+-------------------+-------------+---------+---------------------+
| block             | schema      | storage | fields              |
+-------------------+-------------+---------+---------------------+
| my-theme/app      | subscribers | table   | email, name, plan   |
| my-theme/app      | logs        | jsonc   | action, details     |
| my-theme/app      | events      | storh   | title, status       |
+-------------------+-------------+---------+---------------------+

Операції CRUD

Командна оболонка
# List records
wp bs db list my-theme/app subscribers

# List with filters
wp bs db list my-theme/app subscribers --plan=pro --limit=10

# Get a single record
wp bs db get my-theme/app subscribers 1

# Create a record
wp bs db create my-theme/app subscribers --email=a@b.com --plan=pro

# Update a record
wp bs db update my-theme/app subscribers 1 --plan=enterprise

# Delete a record
wp bs db delete my-theme/app subscribers 1

Для блоків з однією схемою за замовчуванням використовується назва схеми default:

Командна оболонка
wp bs db list my-theme/leads

Перенесення записів JSONC до Storh

Використовуйте migrate, якщо схема вже має файл db/{schema}.jsonc і потрібно перенести ці записи до файлового сховища Storh:

Командна оболонка
wp bs db migrate my-theme/app subscribers --to=storh

Для блоків з однією схемою:

Командна оболонка
wp bs db migrate my-theme/app --to=storh

Команда зберігає цілочислові ідентифікатори записів, записує дані до uploads/blockstudio/db/{block-scope}/{schema}/, перебудовує індекси Storh, перевіряє цільове сховище й залишає вихідний файл .jsonc на місці.

Формати виведення

Усі команди списків підтримують --format=table (за замовчуванням), --format=json і --format=csv:

Командна оболонка
wp bs db list my-theme/app subscribers --format=json

RPC

Перелік усіх функцій

Командна оболонка
wp bs rpc list
Код
+-------------------+-------------+--------+----------------+---------+
| block             | function    | public | capability     | methods |
+-------------------+-------------+--------+----------------+---------+
| my-theme/app      | subscribe   | yes    |                | POST    |
| my-theme/app      | stats       |        | edit_posts     | POST    |
| my-theme/app      | get_status  |        |                | GET,POST|
+-------------------+-------------+--------+----------------+---------+

Виклик функції

Командна оболонка
wp bs rpc call my-theme/app subscribe --email=user@example.com

Формат виведення — JSON:

JSON
{
  "success": true
}

Параметри передаються як прапорці --key=value:

Командна оболонка
wp bs rpc call my-theme/app load_more --offset=10 --limit=5

Cron

Перелік усіх завдань

Командна оболонка
wp bs cron list
Код
+-------------------+----------+----------+---------------------+
| block             | job      | schedule | next_run            |
+-------------------+----------+----------+---------------------+
| my-theme/app      | cleanup  | daily    | 2026-03-17 00:00:00 |
| my-theme/app      | sync     | hourly   | 2026-03-16 15:00:00 |
+-------------------+----------+----------+---------------------+

Ручний запуск завдання

Командна оболонка
wp bs cron run my-theme/app cleanup

Це негайно виконує зворотний виклик незалежно від розкладу. Зручно для тестування та налагодження.

Налаштування

Перегляд усіх налаштувань

Командна оболонка
wp bs settings list

Отримання певного налаштування

Командна оболонка
wp bs settings get tailwind/enabled
wp bs settings get assets/enqueue

Tailwind

Компіляція HTML у CSS

Командна оболонка
wp bs tailwind compile '<div class="flex items-center p-4">'

Компіляція з файла

Командна оболонка
wp bs tailwind compile --file=template.html

Керування кешем

Командна оболонка
wp bs tailwind cache path    # show cache directory
wp bs tailwind cache clear   # clear compiled cache

SCSS

Компіляція SCSS у CSS

Командна оболонка
wp bs scss compile '$color: red; .test { color: $color; }'

Компіляція з файла

Командна оболонка
wp bs scss compile --file=styles.scss

Користувацькі поля

Перелік усіх зареєстрованих користувацьких полів

Командна оболонка
wp bs fields list
Код
+-------+----------------+---------------------------+
| name  | title          | fields                    |
+-------+----------------+---------------------------+
| hero  | Hero Section   | heading, description, cta |
| card  | Card           | title, image, link        |
+-------+----------------+---------------------------+

Ресурси

Перелік усіх ресурсів

Командна оболонка
wp bs assets list

Фільтрування за типом

Командна оболонка
wp bs assets list --type=global
wp bs assets list --type=admin
wp bs assets list --type=editor
wp bs assets list --type=registered

Скрипти

Усі команди підтримують --format=json для зручного передавання через конвеєр:

Командна оболонка
# Export all subscribers as JSON
wp bs db list my-theme/app subscribers --format=json > subscribers.json

# Count records
wp bs db list my-theme/app subscribers --format=json | jq length

# Batch delete
wp bs db list my-theme/app logs --format=json | \
  jq -r '.[].id' | \
  xargs -I {} wp bs db delete my-theme/app logs {}

Синхронізація вмісту

Проєкти Content Sync експортують дозволений вміст WordPress у файли та застосовують ці файли до бази даних. Синхронізація виконується явно й запускається CLI; вона не відбувається під час завантаження сторінки або ініціалізації адміністративної панелі.

Див. Content Sync, щоб дізнатися про налаштування, формат файлів і випадки, коли файлове зберігання вмісту бази даних є доречним.

Вивантаження вмісту бази даних у файли

Командна оболонка
wp bs content pull

Обмежте вивантаження одним налаштованим типом публікації або таксономією:

Командна оболонка
wp bs content pull --post-type=team_member
wp bs content pull --taxonomy=category

Попередній перегляд без запису UID або файлів:

Командна оболонка
wp bs content pull --dry-run

Завантаження файлів до бази даних

Командна оболонка
wp bs content push

Попередній перегляд плану застосування без запису:

Командна оболонка
wp bs content push --dry-run

Видаліть публікації та терміни бази даних, якими керує набір вмісту та яких більше немає у файлах:

Командна оболонка
wp bs content push --prune --yes

Якщо вказано --prune, Blockstudio спершу застосовує всі зміни у файлах, а потім видаляє сутності, якими керує набір вмісту та яких більше немає у файлах. Команда відмовиться від деструктивного очищення, якщо не вказано --yes.

Перевірка стану

Командна оболонка
wp bs content status

У таблиці кожну сутність, що зберігається у файлі, позначено як unchanged, would-update, missing-db, conflict, locked або orphaned.

Статичне попереднє відтворення

Див. Статичне попереднє відтворення — там описано сам кеш; ці команди керують ним.

Оновлення застарілих записів

Командна оболонка
wp bs prerender warm

Додає застарілі публічні URL до черги, а потім повторно відображає до warm.concurrency завдань із постійної черги оновлення й виводить підсумок JSON з кількістю queued, processed, warmed, skipped і failed. Зміни вмісту й сайту автоматично додають завдання на заміну. Запустіть команду знову або дочекайтеся запуску планового засобу оновлення, щоб обробити більшу чергу; URL, який не вдалося відобразити, залишається застарілим і знову додається до черги під час наступного запуску. У режимі graph оновлення для кожного URL вимкнено, і команда нічого не додає до черги.

Звіт про стан кешу

Командна оболонка
wp bs prerender status

Виводить активну ідентичність, файли, байти, записи графа, стан черги, звіт про карту раннього обслуговування та лічильники влучань, промахів, побудов і помилок для кожної області.

Очищення кешу

Командна оболонка
wp bs prerender purge

Видаляє попередньо відтворені документи поточного сайту. Наступний анонімний запит або прохід оновлення побудує їх знову.

Перевірка й очищення карти раннього обслуговування

Командна оболонка
wp bs prerender map status
wp bs prerender map prune --dry-run
wp bs prerender map prune

map status виводить карту раннього обслуговування для всієї інсталяції: її записи й маршрути, відсутні документи маршрутів, записи orphaned для сайтів, яких більше не існує, і записи dead для каталогів, яких більше немає. map prune видаляє осиротілі й недійсні записи та виводить кожен видалений запис із поясненням; --dry-run виводить той самий звіт без запису змін. Карта, якою керує інший інструмент, не змінюється.

WPML

Створення мовної конфігурації

Командна оболонка
wp bs wpml config
wp bs wpml config --file=wp-content/themes/my-theme/wpml-config.xml

Виводить wpml-config.xml, у якому текстові поля кожного зареєстрованого блока позначено для перекладу, а його файлові поля — як ID вкладень, або записує цю конфігурацію за допомогою --file. У наявному файлі замінюється лише розділ між маркерами Blockstudio. Див. WPML, щоб дізнатися, що саме вказується та як підтримувати файл в актуальному стані.

Перенесення тегів блоків

Окремий скрипт переписує скорочення префіксів і псевдонімів у канонічний запис <bs:namespace-slug>. Він не завантажує WordPress і нічого не записує, якщо явно не передано --apply:

Командна оболонка
php vendor/blockstudio/blockstudio/bin/migrate-block-tags.php \
  --root="$PWD" \
  --prefix-map=/tmp/project-prefixes.json \
  --known-blocks=/tmp/project-blocks.json \
  --aliases=/tmp/project-aliases.json \
  --report=/tmp/blockstudio-tag-migration.json \
  --dry-run

Файл префіксів зіставляє префікси, якими керує викликач, із впорядкованими просторами імен. Файл відомих блоків — це список зареєстрованих назв блоків у форматі JSON. Точні псевдоніми необов’язкові. Звіт містить детерміновані зіставлення, хеші до й після змін, невідомі теги, неоднозначні псевдоніми, динамічні теги й приклади, знайдені в коментарях, блоках коду, діапазонах <pre> або <code>.

Сканер обробляє парну, вкладену й самозакривну розмітку, зокрема буквальні теги в рядках PHP. Він зберігає атрибути й змінює лише назви тегів. Коментарі та приклади коду додаються лише до звіту. Сторонні користувацькі елементи ігноруються. Застосування перенесення блокується, поки залишаються невідомі, неоднозначні або динамічні випадки, якщо викликач навмисно не передасть --allow-unresolved. Повторний запуск команди для канонічного результату не вносить змін.

Див. Перенесення, щоб дізнатися, навіщо потрібен канонічний запис і які проблеми він розв’язує.

Видалення

Командна оболонка
wp bs teardown

Видаляє події cron і стан статичного попереднього відтворення, якими володіє інсталяція: запис карти раннього обслуговування поточного сайту, а також спільний drop-in advanced-cache.php і декларацію WP_CACHE після видалення останнього керованого запису. Інсталяції без перехоплювача деактивації плагіна, наприклад конфігурації з комплектним Composer, використовують цю команду для повного видалення. Файли конфігурації залишаються без змін.