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 содержит список с отдельной записью для каждого отображённого блока, в том числе для блоков без проблем, поэтому автоматизация может определить, какой случай использовался:
[
{
"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:
{
"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
Это немедленно выполняет callback независимо от расписания. Полезно для тестирования и отладки.
Настройки
Показать все настройки
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; она не выполняется при загрузке страницы или инициализации панели администратора.
См. раздел Синхронизация содержимого, где описаны настройки, формат файлов и рекомендации о том, когда стоит хранить содержимое базы данных в файлах.
Выгрузка содержимого базы данных в файлы
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, в котором текстовые поля каждого зарегистрированного блока объявляются для перевода, а поля файлов — как идентификаторы вложений, или записывает его с помощью --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, используйте эту команду для полного удаления. Файлы конфигурации остаются нетронутыми.