Preskočiť na obsah

CLI

Blockstudio registruje príkazy WP-CLI na správu blokov, stránok uložených v súboroch, databázových záznamov, funkcií RPC, úloh cron, nastavení a jazykovej konfigurácie WPML z terminálu.

Bloky

Zobraziť všetky bloky

Shell
wp bs blocks list
Kód
+----------------------------+---------------------+-----------+------------------------+
| name                       | title               | component | category               |
+----------------------------+---------------------+-----------+------------------------+
| my-theme/hero              | Hero                |           | my-theme               |
| my-theme/card              | Card                | yes       | my-theme               |
| my-theme/newsletter        | Newsletter          |           | my-theme               |
+----------------------------+---------------------+-----------+------------------------+

Filtrovať iba komponenty

Shell
wp bs blocks list --components

Výstup vo formáte JSON

Shell
wp bs blocks list --format=json

Overenie uložených polí

Shell
wp bs blocks validate 42
wp bs blocks validate 42 57 --format=json

Kontroluje uložený obsah zadaných ID príspevkov vrátane vnorených innerBlocks pomocou bs_validate_block(). Bloky nevykresľuje, nerozbaľuje odkazy na synchronizované vzory ani neupravuje príspevky. Neznáme bloky bez rozšírení Blockstudio sa preskočia.

Predvolená tabuľka uvádza ID príspevku, cestu k bloku s indexovaním od nuly, názov bloku, kód zistenia, cestu k poľu, zdroj a správu. JSON obsahuje aj pôvodné hodnoty value a expected. Vnorený blok môže mať cestu k bloku 0/1 a cestu k poľu cards/2/style; ide o dve samostatné cesty.

Príkaz skončí s 0, ak sa nenašli žiadne problémy, a s 1, ak sa problémy našli. Výstup JSON je jednoduchý zoznam, ktorý pri úspechu obsahuje aj [], takže ho môže automatizácia čítať aj vtedy, keď príkaz skončí s 1. Chýbajúce príspevky, chýbajúce ID a iné formáty než table alebo json spôsobia chybu. Všetky ID sa skontrolujú pred začiatkom overovania.

Vykreslenie blokov

Shell
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

Vykresľuje registrované bloky tak, ako na stránke, a hlási každé upozornenie PHP, varovanie, zastaranie a vyvolanú chybu, ktoré ich šablóny spôsobia. Téma môže príkaz spustiť v CI a otestovať tak bloky v prostredí s nainštalovaným Blockstudio. Ak neuvediete názvy, vykreslia sa všetky registrované bloky vrátane komponentov.

Každý blok sa vykreslí cez do_blocks() z komentára bloku s blockstudio.attributes, teda v podobe, ktorú ukladá editor, v kontexte frontendu WP-CLI, nie v náhľade vkladača. Pre vykreslenie sa nenastaví žiadny dopytovaný príspevok. Dynamické ostrovy vykreslia skutočné telo svojej šablóny, nie iba zástupný obsah, a vedľajší výstup šablóny sa do správy nezahrnie.

Samotný príkaz príspevky ani hodnoty polí neukladá, no spúšťa vaše šablóny a vykresľovacie háky ako bežné PHP. Môžu zapisovať údaje, volať externé služby alebo mať iné vedľajšie účinky. Spúšťajte ho na dôveryhodnom kóde na vyhradenej testovacej stránke; nejde o prostredie s izoláciou iba na čítanie.

Atribúty vykreslenia sa vyberajú pre každý blok osobitne:

Prípad Atribúty
example example.attributes bloku block.json, teda hodnoty, ktoré používa náhľad vkladača.
defaults default každého poľa. Používa sa pri blokoch bez example.attributes; príkaz vypíše riadok pre každé pole.
attributes Hodnoty --attributes, ktoré nahradia príklad.

--attributes prijíma objekt JSON s hodnotami polí usporiadanými podľa kľúča úložiska alebo @ a cestu k súboru, ktorý taký objekt obsahuje. Vyžaduje presne jeden názov bloku. Použite ho na sprístupnenie vetiev šablóny, ktoré príklad nezahŕňa, napríklad variantu. Príkladové hodnoty, ktoré v náhľade vkladača vytvárajú iba zástupné obrázky, sa preskočia a innerBlocks príkladu sa nevykreslia.

Kód
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| 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    |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+

Tabuľka obsahuje jeden riadok pre každý problém. Výstup JSON je zoznam s jednou položkou pre každý vykreslený blok vrátane blokov bez problémov, takže automatizácia môže zistiť, ktorý prípad sa použil:

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 je Notice, Warning, Deprecated alebo Error. Problém, ktorý sa opakuje na rovnakom súbore a riadku, napríklad v cykle, sa nahlási raz pre každý blok. Problémy potlačené pomocou @ sa nehlásia. WordPress vyvoláva vlastné upozornenia na zastaranie, napríklad upozornenia _deprecated_function(), iba keď je povolené WP_DEBUG.

Príkaz skončí s 0, keď sa nenájdu žiadne problémy, a inak s 1. Neznáme názvy blokov, nečitateľné alebo neplatné --attributes a iné formáty než table alebo json spôsobia chybu. Všetky názvy sa skontrolujú pred vykreslením prvého bloku.

Stránky

Synchronizácia stránok uložených v súboroch je explicitná. Bežné požiadavky WordPress nikdy nevykonávajú úplné vyhľadávanie stránok ani nezapisujú príspevky stránok. Pri spustení môže neinicilizované prostredie raz načítať manifesty kolekcií na obnovenie trás, bez synchronizácie obsahu.

Shell
wp bs pages sync

Príkaz zosúladí kompletný požadovaný zoznam a oznámi nájdené, vytvorené, aktualizované, nezmenené, uzamknuté, zachované, odstránené a neúspešne spracované stránky. Rovnaké odtlačky nemenia príspevky ani metadáta príspevkov.

Tabuľkový výstup uvádza zmenené, uzamknuté, so zachovaným obsahom a odstránené stránky spolu s ich ID príspevkov. JSON zahŕňa aj položky pages.<name>.preserved, pages.<name>.overwritten a removedPages s názvom stránky, kľúčom, ID príspevku a akciou čistenia. Príspevok, ktorý je po zlúčení podľa kľúčov totožný s existujúcim, sa označí ako nezmenený bez vytvorenia revízie alebo aktualizácie času úpravy.

Existujúce stavy publikovania sa zachovajú; náhrady názvu a slugu spravované súborom sa vypíšu ako varovania. Pozrite si Vlastníctvo polí príspevku.

Pomocou --authoritative nahradíte spravovaný obsah namiesto zachovania obsahu editora priradeného ku kľúčom a pomocou --full označíte priebeh ako úplné zosúladenie bez ohľadu na uloženú identitu zdroja. V oboch prípadoch sa porovná celý inventár:

Shell
wp bs pages sync --authoritative --full

Pre nasadzovacie skripty, ktoré potrebujú úplný prehľad:

Shell
wp bs pages sync --format=json

Každá stránka analyzovaná príkazom sa kontroluje na atribúty, ktoré jej bloky ukladajú, ale nikdy nevykreslia: atribúty, ktoré blok Blockstudio ani nedefinuje ako pole, ani neodovzdáva svojmu koreňovému prvku, napríklad nedefinovaný class. Tabuľkový výstup vypíše upozornenie pre každú stránku a blok, stĺpec dropped ich spočíta a prehľad JSON ich uvedie v časti pages.<name>.droppedAttributes. Stránky, ktorých zdroj sa nezmenil, sa znova neanalyzujú, takže sa nahlásia pri najbližšej zmene alebo pri prvej synchronizácii po aktualizácii, ktorá zmení analyzátor.

Príkaz skončí s neúspechom, ak vyhľadávanie alebo zosúladenie nahlási chybu. Pozrite si Stránky, kde nájdete zmluvu pre PHP API a identitu nasadenia.

Databáza

Zobraziť schémy

Shell
wp bs db schemas
Kód
+-------------------+-------------+---------+---------------------+
| 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       |
+-------------------+-------------+---------+---------------------+

Operácie CRUD

Shell
# 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

Pri blokoch s jedinou schémou je predvolený názov schémy default:

Shell
wp bs db list my-theme/leads

Migrovať záznamy JSONC do Storh

Použite migrate, ak už schéma obsahuje súbor db/{schema}.jsonc a chcete presunúť tieto záznamy do úložiska Storh založeného na súboroch:

Shell
wp bs db migrate my-theme/app subscribers --to=storh

Pre bloky s jednou schémou:

Shell
wp bs db migrate my-theme/app --to=storh

Príkaz zachová celočíselné ID záznamov, zapisuje do uploads/blockstudio/db/{block-scope}/{schema}/, obnoví indexy Storh, overí cieľové úložisko a ponechá zdrojový súbor .jsonc na mieste.

Formáty výstupu

Všetky príkazy na zobrazenie zoznamu podporujú --format=table (predvolené), --format=json a --format=csv:

Shell
wp bs db list my-theme/app subscribers --format=json

RPC

Zobraziť všetky funkcie

Shell
wp bs rpc list
Kód
+-------------------+-------------+--------+----------------+---------+
| 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|
+-------------------+-------------+--------+----------------+---------+

Zavolať funkciu

Shell
wp bs rpc call my-theme/app subscribe --email=user@example.com

Výstup je vo formáte JSON:

JSON
{
  "success": true
}

Parametre sa odovzdávajú ako príznaky --key=value:

Shell
wp bs rpc call my-theme/app load_more --offset=10 --limit=5

Cron

Zobraziť všetky úlohy

Shell
wp bs cron list
Kód
+-------------------+----------+----------+---------------------+
| 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 |
+-------------------+----------+----------+---------------------+

Spustiť úlohu manuálne

Shell
wp bs cron run my-theme/app cleanup

Tým sa okamžite vykoná spätné volanie bez ohľadu na plán. Hodí sa na testovanie a ladenie.

Nastavenia

Zobraziť všetky nastavenia

Shell
wp bs settings list

Získať konkrétne nastavenie

Shell
wp bs settings get tailwind/enabled
wp bs settings get assets/enqueue

Tailwind

Kompilovať HTML do CSS

Shell
wp bs tailwind compile '<div class="flex items-center p-4">'

Kompilovať zo súboru

Shell
wp bs tailwind compile --file=template.html

Správa vyrovnávacej pamäte

Shell
wp bs tailwind cache path    # show cache directory
wp bs tailwind cache clear   # clear compiled cache

SCSS

Kompilovať SCSS do CSS

Shell
wp bs scss compile '$color: red; .test { color: $color; }'

Kompilovať zo súboru

Shell
wp bs scss compile --file=styles.scss

Vlastné polia

Zobraziť všetky zaregistrované vlastné polia

Shell
wp bs fields list
Kód
+-------+----------------+---------------------------+
| name  | title          | fields                    |
+-------+----------------+---------------------------+
| hero  | Hero Section   | heading, description, cta |
| card  | Card           | title, image, link        |
+-------+----------------+---------------------------+

Zdroje

Zobraziť všetky zdroje

Shell
wp bs assets list

Filtrovať podľa typu

Shell
wp bs assets list --type=global
wp bs assets list --type=admin
wp bs assets list --type=editor
wp bs assets list --type=registered

Skriptovanie

Všetky príkazy podporujú --format=json na jednoduché reťazenie výstupu:

Shell
# 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 {}

Synchronizácia obsahu

Projekty Content Sync zapisujú povolený obsah WordPress do súborov a potom tieto súbory aplikujú späť do databázy. Proces je explicitný a riadený CLI; nesynchronizuje sa pri načítaní stránky ani pri inicializácii administrácie.

Pozrite si Synchronizáciu obsahu, kde nájdete konfiguráciu, formát súborov a pokyny, kedy sa obsah databázy založený na súboroch hodí.

Stiahnuť obsah databázy do súborov

Shell
wp bs content pull

Obmedziť sťahovanie na jeden nakonfigurovaný typ príspevku alebo taxonómiu:

Shell
wp bs content pull --post-type=team_member
wp bs content pull --taxonomy=category

Zobraziť náhľad bez zápisu UID alebo súborov:

Shell
wp bs content pull --dry-run

Nahrať súbory do databázy

Shell
wp bs content push

Zobraziť náhľad plánu aplikovania bez zápisu:

Shell
wp bs content push --dry-run

Odstrániť príspevky a termíny databázy vlastnené obsahovou sadou, ktoré už v súboroch neexistujú:

Shell
wp bs content push --prune --yes

Pomocou --prune Blockstudio najprv aplikuje všetky zmeny v súboroch a potom odstráni entity vlastnené obsahovou sadou, ktoré už v súboroch neexistujú. Odmietne vykonať deštruktívne čistenie, ak nie je uvedené --yes.

Skontrolovať stav

Shell
wp bs content status

Tabuľka uvádza stav každej entity uloženej v súbore ako unchanged, would-update, missing-db, conflict, locked alebo orphaned.

Statické predvykresľovanie

Samotnú vyrovnávaciu pamäť opisuje Statické predvykresľovanie; tieto príkazy ju obsluhujú.

Predhriať zastarané záznamy

Shell
wp bs prerender warm

Zaradí zastarané verejné adresy URL do frontu, potom znova vykreslí až warm.concurrency úloh z trvalého frontu predhrievania a vypíše súhrn JSON s počtami queued, processed, warmed, skipped a failed. Zmeny obsahu a webu automaticky zaradia náhradné úlohy. Ak chcete spracovať väčší front, spustite príkaz znova alebo nechajte bežať plánovaný proces predhrievania; URL, ktorého vykreslenie zlyhá, zostane zastaraný a pri ďalšom spustení sa znova zaradí do frontu. V režime graph je predhrievanie pre jednotlivé URL vypnuté a príkaz nič nezaraďuje do frontu.

Zobraziť stav vyrovnávacej pamäte

Shell
wp bs prerender status

Vypíše aktívnu identitu, súbory, bajty, záznamy grafu, stav frontu, prehľad mapy rýchleho zobrazovania a počítadlá zásahov, minutí, zostavení a zlyhaní pre jednotlivé rozsahy.

Vymazať vyrovnávaciu pamäť

Shell
wp bs prerender purge

Odstráni predvykreslené dokumenty aktuálnej stránky. Pri ďalšej anonymnej požiadavke alebo predhrievacom priechode sa znova vytvoria.

Skontrolovať a vyčistiť mapu rýchleho zobrazovania

Shell
wp bs prerender map status
wp bs prerender map prune --dry-run
wp bs prerender map prune

map status zobrazí mapu rýchleho zobrazovania platnú pre celú inštaláciu: jej položky a trasy, chýbajúce dokumenty trás, položky orphaned, ktorých stránka už neexistuje, a položky dead, ktorých adresár zmizol. map prune odstráni osirelé a neplatné položky a pri každej vypíše dôvod odstránenia; --dry-run zobrazí rovnaký prehľad bez zápisu. Mapa vlastnená iným nástrojom zostane nedotknutá.

WPML

Generovanie jazykovej konfigurácie

Shell
wp bs wpml config
wp bs wpml config --file=wp-content/themes/my-theme/wpml-config.xml

Vypíše wpml-config.xml, ktoré určuje textové polia každého registrovaného bloku určené na preklad a jeho súborové polia ako ID príloh, alebo ju zapíše pomocou --file. V existujúcom súbore sa nahradí iba časť medzi značkami Blockstudio. Informácie o tom, čo sa deklaruje a ako udržiavať súbor aktuálny, nájdete v WPML.

Migrácia značiek blokov

Samostatný skript prepíše skrátené zápisy prefixov a aliasov do kanonického zápisu <bs:namespace-slug>. Nenačítava WordPress a nič nezapisuje, ak nie je explicitne zadané --apply:

Shell
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

Súbor prefixov mapuje prefixy spravované volajúcim na zoradené menné priestory. Súbor známych blokov je zoznam JSON zaregistrovaných názvov blokov. Presné aliasy sú voliteľné. Prehľad obsahuje deterministické mapovania, kontrolné súčty pred a po, neznáme značky, nejednoznačné aliasy, dynamické značky a príklady nájdené v komentároch, blokoch kódu, rozsahoch <pre> alebo <code>.

Skener spracúva párové, vnorené aj samostatne uzatvárané značky vrátane doslovných značiek v reťazcoch PHP. Zachováva atribúty a mení iba názvy značiek. Komentáre a ukážky kódu sa iba uvádzajú v prehľade. Nesúvisiace vlastné prvky sa ignorujú. Použitie migrácie je zablokované, kým zostávajú neznáme, nejednoznačné alebo dynamické prípady, ak volajúci zámerne nezadá --allow-unresolved. Opätovné spustenie príkazu nad kanonickým výstupom nevykoná žiadne zmeny.

Pozrite si Migráciu, kde sa dozviete, prečo existuje kanonický zápis a čo rieši.

Odstránenie

Shell
wp bs teardown

Odstráni udalosti cron a stav statického predvykresľovania, ktoré vlastní inštalácia: položku mapy rýchleho zobrazovania aktuálnej stránky a zdieľaný doplnkový súbor advanced-cache.php a deklaráciu WP_CACHE, keď už nezostáva žiadna vlastnená položka. Inštalácie bez háku na deaktiváciu doplnku, napríklad nastavenia s balíkom Composer, týmto príkazom dosiahnu čisté odstránenie. Konfiguračné súbory zostanú nedotknuté.