Към съдържанието

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 на публикацията и действието по почистване. Идентична публикация след сливане по ключове се отчита като непроменена, без да се създава редакция или да се обновява времевият ѝ печат за промяна.

Съществуващите статуси на публикуване се запазват; замените на заглавие и slug, зададени от файл, се извеждат като предупреждения. Вижте Собственост върху полетата на публикацията.

Използвайте --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

Командата запазва целочислените ID на записите, записва в 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, използват тази команда за чисто премахване. Конфигурационните файлове не се променят.