Přejít k obsahu

CLI

Blockstudio registruje příkazy WP-CLI pro správu bloků, stránek uložených v souborech, databázových záznamů, funkcí RPC, úloh cron, nastavení a jazykové konfigurace WPML z terminálu.

Bloky

Vypsat všechny 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               |
+----------------------------+---------------------+-----------+------------------------+

Filtrovat pouze komponenty

Shell
wp bs blocks list --components

Výstup ve formátu JSON

Shell
wp bs blocks list --format=json

Ověření 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 příspěvků včetně vnořených innerBlocks pomocí bs_validate_block(). Bloky nevykresluje, nerozbalí odkazy na synchronizované vzory ani neupravuje příspěvky. Neznámé bloky bez rozšíření Blockstudio se přeskočí.

Výchozí tabulka uvádí ID příspěvku, cestu k bloku s indexováním od nuly, název bloku, kód nálezu, cestu k poli, zdroj a zprávu. JSON zahrnuje také původní hodnoty value a expected. Vnořený blok může mít cestu k bloku 0/1 a cestu k poli cards/2/style; jde o dvě samostatné cesty.

Při nulovém počtu nálezů příkaz skončí s 0, při jejich výskytu s 1. Výstup JSON je prostý seznam, který při úspěchu obsahuje i [], takže jej mohou číst automatizační nástroje, i když příkaz skončí s 1. Chybějící příspěvky nebo ID a jiné formáty než table či json jsou chyby. Všechna ID se ověří před zahájením kontroly.

Vykreslení bloků

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

Vykreslí registrované bloky stejně jako stránka a zaznamená všechna oznámení PHP, upozornění, zastaralá volání a vyhozené chyby, které jejich šablony vyvolají. Motiv může příkaz spustit v CI a orientačně tak otestovat bloky v nainstalovaném Blockstudio. Bez zadání názvů se vykreslí všechny registrované bloky včetně komponent.

Každý blok se vykreslí pomocí do_blocks() z komentáře bloku s blockstudio.attributes, tedy ve tvaru, který ukládá editor, v kontextu frontendu WP-CLI, nikoli v náhledu vkládacího panelu. Pro vykreslení se nenastavuje žádný dotazovaný příspěvek. Dynamické části se vykreslí se skutečným tělem šablony, nikoli jen se zástupným obsahem, a vedlejší výstup šablony se do přehledu nezahrne.

Příkaz sám neukládá příspěvky ani hodnoty polí, ale spouští vaše šablony a vykreslovací hooky jako běžný PHP. Mohou zapisovat data, volat externí služby nebo mít jiné vedlejší účinky. Spouštějte jej s důvěryhodným kódem na vyhrazeném testovacím webu; nejde o sandbox pouze pro čtení.

Atributy vykreslení se vybírají pro každý blok zvlášť:

Případ Atributy
example example.attributes bloku block.json, tedy hodnoty, které používá náhled vkládacího panelu.
defaults default každého pole. Používá se u bloků bez example.attributes; příkaz vypíše řádek pro každé pole.
attributes Hodnoty --attributes, které nahrazují příklad.

--attributes přijímá objekt JSON s hodnotami polí přiřazenými podle úložného klíče, případně @ a cestu k souboru, který takový objekt obsahuje; je nutné zadat přesně jeden název bloku. Použijte jej pro zobrazení větví šablony, které příklad nepokrývá, například varianty. Příkladové hodnoty, které v náhledu vkládacího panelu vytvářejí pouze zástupné obrázky, se přeskočí a innerBlocks příkladu se nevykreslí.

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    |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+

Tabulka uvádí jeden řádek pro každý problém. Výstup JSON je seznam s jednou položkou pro každý vykreslený blok, včetně bloků bez problémů, takže automatizace může zjistit, který případ byl použit:

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 nebo Error. Problém opakující se na stejném souboru a řádku, například ve smyčce, se u každého bloku hlásí pouze jednou. Problémy potlačené pomocí @ se nehlásí. WordPress vyvolává vlastní oznámení o zastaralém použití, například u _deprecated_function(), pouze pokud je povoleno WP_DEBUG.

Pokud nejsou nalezeny žádné problémy, příkaz skončí s 0, jinak s 1. Neznámé názvy bloků, nečitelné nebo neplatné --attributes a jiné formáty než table či json jsou chyby; všechny názvy se ověří před vykreslením prvního bloku.

Stránky

Synchronizace stránek uložených v souborech probíhá výslovně. Běžné požadavky WordPress nikdy neprovádějí úplné vyhledání stránek ani nezapisují příspěvky stránek. Při studeném startu může běhové prostředí jednou načíst manifesty kolekcí, aby obnovilo trasy, aniž by synchronizovalo obsah.

Shell
wp bs pages sync

Příkaz uvede celý požadovaný inventář do souladu a oznámí nově zjištěné, vytvořené, aktualizované, nezměněné, uzamčené, zachované, odstraněné a neúspěšně zpracované stránky. Shodné otisky nevedou k zápisu příspěvků ani metadat příspěvků.

Tabulkový výstup uvádí změněné, uzamčené, obsahově zachované a odstraněné stránky spolu s jejich ID příspěvků. JSON zahrnuje položky pages.<name>.preserved, pages.<name>.overwritten a removedPages s názvem stránky, klíčem, ID příspěvku a akcí úklidu. Identický příspěvek po sloučení podle klíčů se označí jako nezměněný, aniž by vznikla revize nebo se posunulo jeho datum úpravy.

Stávající stavy publikování se zachovají; náhrady názvů a slugů převzaté ze souborů se vypíší jako upozornění. Viz Vlastnictví polí příspěvku.

Pomocí --authoritative nahraďte spravovaný obsah namísto zachování obsahu editoru označeného klíči a pomocí --full označte průchod jako úplné sladění bez ohledu na uloženou identitu zdroje. Každý průchod v obou případech porovná celý inventář:

Shell
wp bs pages sync --authoritative --full

Pro nasazovací skripty, které potřebují úplný výpis:

Shell
wp bs pages sync --format=json

U každé stránky, kterou příkaz analyzuje, se kontrolují atributy, které její bloky ukládají, ale nikdy nevykreslují: atributy, které blok Blockstudio ani nedefinuje jako pole, ani nepředává svému kořenovému prvku, například nedefinovaný atribut class. Tabulkový výstup zobrazí varování pro každou stránku a blok, sloupec dropped udává jejich počet a výpis JSON je uvádí v části pages.<name>.droppedAttributes. Stránky, jejichž zdroj se nezměnil, se znovu neanalyzují; nahlášeny budou při příští změně nebo při první synchronizaci po aktualizaci, která změní analyzátor.

Příkaz skončí neúspěšně, pokud vyhledání nebo sladění ohlásí chybu. Smlouvu týkající se PHP API a identity nasazení najdete v části Stránky.

Databáze

Vypsat schémata

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       |
+-------------------+-------------+---------+---------------------+

Operace 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

U bloků s jediným schématem je výchozím názvem schématu default:

Shell
wp bs db list my-theme/leads

Přenést záznamy JSONC do Storh

Pomocí migrate přeneste záznamy do souborového úložiště Storh, pokud už schéma obsahuje soubor db/{schema}.jsonc:

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

U bloků s jediným schématem:

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

Příkaz zachová celočíselná ID záznamů, zapíše do uploads/blockstudio/db/{block-scope}/{schema}/, znovu vytvoří indexy Storh, ověří cílové úložiště a ponechá zdrojový soubor .jsonc na místě.

Výstupní formáty

Všechny příkazy pro výpis podporují formáty --format=table (výchozí), --format=json a --format=csv:

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

RPC

Vypsat všechny funkce

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|
+-------------------+-------------+--------+----------------+---------+

Zavolat funkci

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

Výstup je ve formátu JSON:

JSON
{
  "success": true
}

Parametry se předávají jako příznaky --key=value:

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

Cron

Vypsat všechny ú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 |
+-------------------+----------+----------+---------------------+

Spustit úlohu ručně

Shell
wp bs cron run my-theme/app cleanup

Tím se okamžitě spustí zpětné volání bez ohledu na plán. Hodí se pro testování a ladění.

Nastavení

Zobrazit všechna nastavení

Shell
wp bs settings list

Získat konkrétní nastavení

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

Tailwind

Převést HTML na CSS

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

Převést ze souboru

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

Správa mezipaměti

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

SCSS

Převést SCSS na CSS

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

Převést ze souboru

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

Vlastní pole

Vypsat všechna registrovaná vlastní pole

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

Assety

Vypsat všechna aktiva

Shell
wp bs assets list

Filtrovat podle 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

Skriptování

Všechny příkazy podporují --format=json pro snadné předávání 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 {}

Synchronizace obsahu

Projekty synchronizace obsahu exportují povolený obsah WordPress do souborů a aplikují tyto soubory zpět do databáze. Synchronizace je výslovná a řízená CLI; neprobíhá při načtení stránky ani při inicializaci administrace.

Informace o konfiguraci, formátu souborů a o tom, kdy je obsah databáze založený na souborech vhodnou volbou, najdete v části Synchronizace obsahu.

Stáhnout obsah databáze do souborů

Shell
wp bs content pull

Omezit stažení na jeden nakonfigurovaný typ příspěvku nebo taxonomii:

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

Náhled bez zápisu UID nebo souborů:

Shell
wp bs content pull --dry-run

Nahrát soubory do databáze

Shell
wp bs content push

Zobrazit náhled plánu změn bez zápisu:

Shell
wp bs content push --dry-run

Odstranit příspěvky a termíny z databáze spravované sadou obsahu, které už v souborech nejsou:

Shell
wp bs content push --prune --yes

S parametrem --prune provede Blockstudio nejprve všechny změny souborů a pak odstraní entity spravované sadou obsahu, které už v souborech nejsou. Destruktivní čištění odmítne spustit, pokud není uveden parametr --yes.

Zkontrolovat stav

Shell
wp bs content status

Tabulka uvádí každou entitu uloženou v souboru jako unchanged, would-update, missing-db, conflict, locked nebo orphaned.

Statické předběžné vykreslování

Samotnou mezipaměť popisuje část Statické předběžné vykreslování; tyto příkazy s ní pracují.

Zahřát zastaralé položky

Shell
wp bs prerender warm

Zařadí zastaralé veřejné URL do fronty, poté z trvalé fronty zahřívání znovu vykreslí až warm.concurrency úloh a vypíše souhrn JSON s počty queued, processed, warmed, skipped a failed. Změny obsahu a webu automaticky zařazují náhradní úlohy. Spuštěním příkazu znovu nebo naplánováním dalšího běhu zahřívacího procesu zpracujete větší část fronty; URL, jehož vykreslení selže, zůstane zastaralý a při příštím spuštění se znovu zařadí. V režimu graph je zahřívací proces pro jednotlivé URL vypnutý a příkaz nic do fronty nezařadí.

Zobrazit stav mezipaměti

Shell
wp bs prerender status

Zobrazí aktivní identitu, soubory, bajty, záznamy grafu, stav fronty, výpis mapy pro přednostní obsluhu a počty zásahů, minutí, sestavení a selhání pro jednotlivé rozsahy.

Vymazat mezipaměť

Shell
wp bs prerender purge

Odebere předběžně vykreslené dokumenty aktuálního webu. Při příštím anonymním požadavku nebo průchodu zahřívacím procesem se znovu vytvoří.

Zkontrolovat a pročistit mapu pro přednostní obsluhu

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

map status vypíše mapu pro přednostní obsluhu pro celou instalaci: její položky a trasy, chybějící dokumenty tras, položky orphaned pro weby, které už neexistují, a položky dead s chybějícími adresáři. map prune odstraní osiřelé a nefunkční položky a vypíše každou odebranou položku i důvod; --dry-run vypíše stejný přehled bez zápisu. Mapa spravovaná jiným nástrojem se nikdy neupravuje.

WPML

Vygenerování jazykové konfigurace

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

Vypíše wpml-config.xml, která určuje textová pole všech registrovaných bloků k překladu a jejich souborová pole jako ID příloh, nebo ji zapíše pomocí --file. V existujícím souboru nahradí pouze část mezi značkami Blockstudio. Popis toho, co se určuje a jak soubor udržovat aktuální, najdete v WPML.

Migrace značek bloků

Samostatný skript přepíše zkrácené zápisy prefixů a aliasů na kanonický zápis <bs:namespace-slug>. Nenačítá WordPress a nic nezapisuje, pokud není výslovně zadán parametr --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

Soubor prefixů mapuje prefixy určené volajícím na seřazené jmenné prostory. Soubor známých bloků je seznam registrovaných názvů bloků ve formátu JSON. Přesné aliasy jsou volitelné. Výpis obsahuje deterministická mapování, otisky před a po změně, neznámé značky, nejednoznačné aliasy, dynamické značky a příklady nalezené v komentářích, blocích kódu, rozsazích <pre> nebo <code>.

Skener zpracovává párové, vnořené i samouzavírací značky, včetně doslovných značek v řetězcích PHP. Zachovává atributy a mění pouze názvy značek. Komentáře a ukázky kódu uvádí pouze ve výpisu. Nesouvisející vlastní prvky ignoruje. Použití migrace je blokováno, dokud zbývají neznámé, nejednoznačné nebo dynamické případy, ledaže volající úmyslně zadá --allow-unresolved. Opětovné spuštění příkazu nad kanonickým výstupem neprovede žádné změny.

Proč kanonický zápis existuje a jaké problémy řeší, se dozvíte v části Migrace.

Odstranění

Shell
wp bs teardown

Odebere události cron a stav statického předběžného vykreslování spravovaný instalací: záznam aktuálního webu v mapě pro přednostní obsluhu a sdílené doplňkové načtení advanced-cache.php i deklaraci WP_CACHE, jakmile zmizí poslední spravovaný záznam. Instalace bez háku pro deaktivaci pluginu, například nastavení dodávaná společně s Composer, použijí tento postup k čistému odstranění. Konfigurační soubory zůstanou nedotčené.