CLI
Blockstudio užregistruoja WP-CLI komandas, skirtas blokams, failuose saugomiems puslapiams, duomenų bazės įrašams, RPC funkcijoms, cron užduotims, nustatymams ir WPML kalbos konfigūracijai valdyti terminale.
Blokai
Visų blokų sąrašas
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 |
+----------------------------+---------------------+-----------+------------------------+
Filtruoti tik komponentus
wp bs blocks list --components
Išvesti kaip JSON
wp bs blocks list --format=json
Išsaugotų laukų tikrinimas
wp bs blocks validate 42
wp bs blocks validate 42 57 --format=json
Tikrina nurodytų įrašų ID išsaugotą turinį, įskaitant įdėtus innerBlocks, naudodamas bs_validate_block().
Blokų nerenderina, nesusietų šablonų nuorodų neišskleidžia ir įrašų nekeičia.
Nežinomi blokai be Blockstudio plėtinių praleidžiami.
Numatytojoje lentelėje pateikiami įrašo ID, bloko kelias nuo nulio, bloko pavadinimas, radinio kodas, lauko kelias, šaltinis ir pranešimas. JSON taip pat pateikia pradines value ir expected reikšmes. Įdėto bloko kelias gali būti 0/1, o lauko kelias – cards/2/style; tai atskiri keliai.
Jei radinių nėra, komanda baigiama su 0, o jei radinių yra – su 1. JSON išvestis yra paprastas sąrašas, kuriame sėkmės atveju taip pat pateikiama [], todėl automatizavimo priemonės gali jį nuskaityti net jei komanda baigiama su 1. Trūkstami įrašai, trūkstami ID ir kiti formatai nei table ar json laikomi klaidomis. Visi ID patikrinami prieš pradedant tikrinimą.
Blokų atvaizdavimas
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
Atvaizduoja užregistruotus blokus taip, kaip puslapis, ir pateikia visus PHP pranešimus, įspėjimus, pasenusių funkcijų pranešimus bei iškeltas klaidas, kurias sukelia jų šablonai. Tema gali vykdyti komandą CI aplinkoje, kad patikrintų, ar jos blokai veikia su įdiegta Blockstudio. Jei pavadinimai nenurodomi, atvaizduojami visi užregistruoti blokai, įskaitant komponentus.
Kiekvienas blokas atvaizduojamas per do_blocks() iš bloko komentaro su blockstudio.attributes – tokia forma, kokią išsaugo redaktorius, – WP-CLI priekinės dalies kontekste, o ne įterpimo peržiūroje. Užklaustas įrašas atvaizdavimui nesukuriamas. Dinaminės salos atvaizduoja tikrąjį šablono turinį, o ne vien vietaženklį, o atsitiktinė šablono išvestis į ataskaitą neįtraukiama.
Pati komanda įrašų ar laukų reikšmių neišsaugo, tačiau vykdo jūsų šablonus ir atvaizdavimo kablius kaip įprasti PHP. Jie gali įrašyti duomenis, iškviesti išorines paslaugas arba sukelti kitą šalutinį poveikį. Vykdykite ją patikimo kodo aplinkoje, tam skirtoje bandomojoje svetainėje; tai nėra tik skaitymui skirta smėliadėžė.
Atvaizdavimo atributai parenkami kiekvienam blokui atskirai:
| Atvejis | Atributai |
|---|---|
example |
Bloko example.attributes block.json reikšmės, kurias naudoja įterpimo peržiūra. |
defaults |
Kiekvieno lauko default. Naudojama blokams be example.attributes; komanda pateikia eilutę kiekvienam. |
attributes |
--attributes reikšmės, pakeičiančios pavyzdį. |
--attributes priima JSON objektą su laukų reikšmėmis, susietomis pagal saugojimo raktą, arba @ ir failo, kuriame jis yra, kelią; taip pat reikia nurodyti tiksliai vieną bloko pavadinimą. Naudokite tai, kad pasiektumėte šablono šakas, kurių pavyzdys neapima, pavyzdžiui, variantą. Pavyzdžių reikšmės, kurios įterpimo peržiūroje sukuria tik vietaženklio vaizdus, praleidžiamos, o pavyzdžio innerBlocks neatvaizduojami.
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| 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 |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
Lentelėje kiekvienai problemai pateikiama atskira eilutė. JSON išvestis yra sąrašas su atskiru įrašu kiekvienam atvaizduotam blokui, įskaitant blokus be problemų, todėl automatizavimo priemonės gali nuskaityti, kuris atvejis buvo naudotas:
[
{
"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 yra Notice, Warning, Deprecated arba Error. Jei problema kartojasi tame pačiame faile ir eilutėje, pavyzdžiui, cikle, ji pateikiama po vieną kartą kiekvienam blokui. Su @ nutildytos problemos nepateikiamos. WordPress sukelia atskirus pasenusių funkcijų pranešimus, pavyzdžiui, _deprecated_function() pranešimus, tik kai įjungta WP_DEBUG.
Jei problemų nerasta, komanda baigiama su 0, kitu atveju – su 1. Nežinomi blokų pavadinimai, neįskaitomi arba netinkami --attributes ir kiti formatai nei table ar json laikomi klaidomis. Visi pavadinimai patikrinami prieš atvaizduojant pirmąjį bloką.
Puslapiai
Failuose saugomų puslapių sinchronizavimas vykdomas aiškiai nurodžius. Įprastos WordPress užklausos niekada neaptinka visų puslapių ir neįrašo puslapių įrašų. Paleidžiant aplinką pirmą kartą, gali būti vieną kartą perskaityti rinkinių manifestai maršrutams atkurti, bet turinys nesinchronizuojamas.
wp bs pages sync
Komanda suderina visą pageidaujamą inventorių ir pateikia rastų, sukurtų, atnaujintų, nepakeistų, užrakintų, išsaugotų ir pašalintų puslapių bei nesėkmių ataskaitą. Sutampantys kontroliniai atspaudai nerašo įrašo ar jo metaduomenų.
Lentelės išvestyje pateikiami pakeisti, užrakinti, su išsaugotu turiniu ir pašalinti puslapiai bei jų įrašų ID. JSON apima pages.<name>.preserved, pages.<name>.overwritten ir removedPages įrašus su puslapio pavadinimu, raktu, įrašo ID ir valymo veiksmu. Po sujungimo pagal raktus identiškas įrašas nurodomas kaip nepakeistas, nesukuriant versijos ir neatnaujinant keitimo laiko žymos.
Esamos publikavimo būsenos išsaugomos; failo valdomi pavadinimo ir nuorodos pakaitalai pateikiami kaip įspėjimai. Žr. Įrašų laukų nuosavybė.
Naudokite --authoritative, kad pakeistumėte tvarkomą turinį, o ne išsaugotumėte pagal raktus susietą
redaktoriaus turinį, ir --full, kad vykdymas būtų laikomas visišku suderinimu,
neatsižvelgiant į išsaugotą šaltinio tapatybę. Kiekvienu atveju palyginamas visas
inventorius:
wp bs pages sync --authoritative --full
Diegimo scenarijams, kuriems reikia visos ataskaitos:
wp bs pages sync --format=json
Kiekviename puslapyje, kurį komanda apdoroja, tikrinami atributai, kuriuos blokai išsaugo,
bet niekada neatvaizduoja: atributai, kurių Blockstudio blokas nei apibrėžia kaip laukų,
nei perduoda savo šakniniam elementui, pavyzdžiui, neapibrėžtas class. Lentelės
išvestyje kiekvienam puslapiui ir blokui pateikiamas įspėjimas, stulpelyje dropped
skaičiuojami tokie atvejai, o JSON ataskaitoje jie išvardijami skiltyje pages.<name>.droppedAttributes. Puslapiai,
kurių šaltinis nepasikeitė, iš naujo neapdorojami, todėl apie juos pranešama kitą kartą,
kai jie pasikeis, arba pirmą kartą sinchronizavus po analizatorių pakeičiančio naujinimo.
Komanda baigiama nesėkmingai, jei aptinkant ar suderinant pranešama apie klaidą. Žr. Puslapiai, kur aprašyta PHP API ir diegimo tapatybės sutartis.
Duomenų bazė
Schemos sąrašas
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 operacijos
# 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
Vienos schemos blokams schemos pavadinimas pagal numatytuosius nustatymus yra default:
wp bs db list my-theme/leads
Perkelti JSONC įrašus į Storh
Naudokite migrate, jei schema jau turi db/{schema}.jsonc failą ir norite
perkelti tuos įrašus į Storh failų saugyklą:
wp bs db migrate my-theme/app subscribers --to=storh
Blokams su viena schema:
wp bs db migrate my-theme/app --to=storh
Komanda išsaugo sveikųjų skaičių įrašų ID, įrašo į
uploads/blockstudio/db/{block-scope}/{schema}/, iš naujo sukuria Storh indeksus,
patikrina tikslinę saugyklą ir palieka šaltinio .jsonc failą.
Išvesties formatai
Visos sąrašo komandos palaiko --format=table (numatytasis), --format=json ir
--format=csv:
wp bs db list my-theme/app subscribers --format=json
RPC
Visų funkcijų sąrašas
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|
+-------------------+-------------+--------+----------------+---------+
Iškviesti funkciją
wp bs rpc call my-theme/app subscribe --email=user@example.com
Išvestis yra JSON:
{
"success": true
}
Parametrai perduodami kaip --key=value vėliavėlės:
wp bs rpc call my-theme/app load_more --offset=10 --limit=5
Cron
Visų užduočių sąrašas
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 |
+-------------------+----------+----------+---------------------+
Paleisti užduotį rankiniu būdu
wp bs cron run my-theme/app cleanup
Taip iškart įvykdoma atgalinio iškvietimo funkcija, neatsižvelgiant į tvarkaraštį. Naudinga bandant ir derinant.
Nustatymai
Rodyti visus nustatymus
wp bs settings list
Gauti konkretų nustatymą
wp bs settings get tailwind/enabled
wp bs settings get assets/enqueue
Tailwind
Kompiliuoti HTML į CSS
wp bs tailwind compile '<div class="flex items-center p-4">'
Kompiliuoti iš failo
wp bs tailwind compile --file=template.html
Talpyklos tvarkymas
wp bs tailwind cache path # show cache directory
wp bs tailwind cache clear # clear compiled cache
SCSS
Kompiliuoti SCSS į CSS
wp bs scss compile '$color: red; .test { color: $color; }'
Kompiliuoti iš failo
wp bs scss compile --file=styles.scss
Pasirinktiniai laukai
Visų registruotų pasirinktinių laukų sąrašas
wp bs fields list
+-------+----------------+---------------------------+
| name | title | fields |
+-------+----------------+---------------------------+
| hero | Hero Section | heading, description, cta |
| card | Card | title, image, link |
+-------+----------------+---------------------------+
Ištekliai
Visų išteklių sąrašas
wp bs assets list
Filtruoti pagal tipą
wp bs assets list --type=global
wp bs assets list --type=admin
wp bs assets list --type=editor
wp bs assets list --type=registered
Skriptai
Visos komandos palaiko --format=json, kad būtų lengva perduoti duomenis:
# 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 {}
Turinio sinchronizavimas
Content Sync eksportuoja į failus WordPress turinį, įtrauktą į leidžiamų sąrašą, ir pritaiko tuos failus duomenų bazei. Sinchronizavimas vykdomas aiškiai nurodžius ir yra valdomas CLI; jis nevyksta įkeliant puslapį ar inicijuojant administravimo aplinką.
Konfigūraciją, failų formatą ir patarimus, kada verta naudoti failais pagrįstą duomenų bazės turinį, rasite skiltyje Turinio sinchronizavimas.
Perkelti duomenų bazės turinį į failus
wp bs content pull
Apriboti perkėlimą iki vieno sukonfigūruoto įrašų tipo arba taksonomijos:
wp bs content pull --post-type=team_member
wp bs content pull --taxonomy=category
Peržiūrėti neįrašant UID ar failų:
wp bs content pull --dry-run
Perkelti failus į duomenų bazę
wp bs content push
Peržiūrėti taikymo planą nieko neįrašant:
wp bs content push --dry-run
Pašalinti turinio rinkiniui priklausančius duomenų bazės įrašus ir terminus, kurių failuose nebėra:
wp bs content push --prune --yes
Kai naudojama --prune, Blockstudio pirmiausia pritaiko visus failų pakeitimus, o tada pašalina turinio rinkiniui priklausančius objektus, kurių failuose nebėra. Destruktyvus pašalinimas nevykdomas, jei nenurodytas --yes.
Tikrinti būseną
wp bs content status
Lentelėje kiekvieno failuose saugomo objekto būsena nurodoma kaip unchanged, would-update, missing-db, conflict, locked arba orphaned.
Statinis išankstinis atvaizdavimas
Pati talpykla aprašyta skiltyje Statinis išankstinis atvaizdavimas; šios komandos ją valdo.
Atnaujinti nebegaliojančius įrašus
wp bs prerender warm
Į eilę įtraukia nebegaliojančius viešus URL, tada iš patvarios atnaujinimo eilės iš naujo atvaizduoja iki warm.concurrency užduočių ir pateikia JSON suvestinę, kurioje nurodyti queued, processed,
warmed, skipped ir failed skaičiai. Pakeitus turinį ar svetainę, nauji darbai įtraukiami į eilę automatiškai. Paleiskite komandą dar kartą arba leiskite suplanuotai atnaujinimo užduočiai apdoroti didesnę eilę; jei nepavyksta atvaizduoti URL, jo būsena lieka nebegaliojanti ir jis vėl įtraukiamas į eilę kitą kartą paleidus komandą. Veikiant graph režimu, kiekvienos URL atnaujinimo užduotis išjungta, todėl komanda nieko neįtraukia į eilę.
Pateikti talpyklos būseną
wp bs prerender status
Pateikia aktyvią tapatybę, failus, baitus, grafiko įrašus, eilės būseną, ankstyvojo pateikimo žemėlapio ataskaitą ir kiekvienos aprėpties pataikymų, nepataikymų, kūrimų ir nesėkmių skaitiklius.
Išvalyti talpyklą
wp bs prerender purge
Pašalina dabartinės svetainės iš anksto atvaizduotus dokumentus. Juos iš naujo sukuria kita anoniminė užklausa arba atnaujinimo eiga.
Tikrinti ir išvalyti ankstyvojo pateikimo žemėlapį
wp bs prerender map status
wp bs prerender map prune --dry-run
wp bs prerender map prune
map status pateikia visos diegimo aplinkos ankstyvojo pateikimo žemėlapio ataskaitą: jo įrašus
ir maršrutus, trūkstamus maršrutų dokumentus, orphaned įrašus, kurių svetainės
nebeegzistuoja, ir dead įrašus, kurių katalogų nebėra. map prune pašalina
našlaičius ir nebegaliojančius įrašus bei pateikia kiekvieno pašalinto įrašo priežastį;
--dry-run pateikia tą pačią ataskaitą nieko neįrašydamas. Kito įrankio valdomas
žemėlapis niekada nekeičiamas.
WPML
Kalbos konfigūracijos generavimas
wp bs wpml config
wp bs wpml config --file=wp-content/themes/my-theme/wpml-config.xml
Išveda wpml-config.xml, kuris deklaruoja visų užregistruotų blokų tekstinius laukus vertimui, o failų laukus – kaip priedų ID, arba įrašo jį naudodamas --file. Esamame faile pakeičiama tik sekcija tarp Blockstudio žymeklių. Žr. WPML, kur paaiškinta, kas deklaruojama ir kaip atnaujinti failą.
Blokų žymų perkėlimas
Atskiras scenarijus perrašo prefiksų ir alternatyvių pavadinimų trumpinius kanonine
<bs:namespace-slug> rašyba. Jis neįkelia WordPress ir nieko neįrašo,
jei aiškiai nepateiktas --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
Prefiksų failas susieja iškvietėjo valdomus prefiksus su išrikiuotomis vardų sritimis. Žinomų
blokų failas yra JSON registruotų blokų pavadinimų sąrašas. Tikslios alternatyvios žymos
nėra būtinos. Ataskaitoje pateikiami deterministiniai susiejimai, maišos prieš ir po pakeitimų,
nežinomos žymos, dviprasmės alternatyvios žymos, dinaminės žymos ir pavyzdžiai, rasti komentaruose,
kodo blokuose, <pre> arba <code> atkarpose.
Analizatorius apdoroja suporuotą, įdėtinį ir savaime užsidarantį žymėjimą, įskaitant pažodines
žymas PHP eilutėse. Jis išsaugo atributus ir keičia tik žymų pavadinimus.
Komentarai ir kodo pavyzdžiai pateikiami tik ataskaitoje. Nesusiję pasirinktiniai elementai
ignoruojami. Perkėlimo taikyti negalima, kol lieka nežinomų, dviprasmių ar dinaminių
atvejų, nebent iškvietėjas sąmoningai nurodo --allow-unresolved.
Dar kartą paleidus komandą su kanonine išvestimi, pakeitimų nebus.
Kodėl naudojama kanoninė rašyba ir kokias problemas ji išsprendžia, žr. skiltyje Perkėlimas.
Pašalinimas
wp bs teardown
Pašalina cron įvykius ir statinio išankstinio atvaizdavimo būseną, kurią valdo diegimo aplinka: dabartinės svetainės ankstyvojo pateikimo žemėlapio įrašą ir bendrą advanced-cache.php
įterpinį bei WP_CACHE deklaraciją, kai pašalinamas paskutinis valdomas įrašas.
Diegimo aplinkose, kuriose nėra papildinio išjungimo funkcijos, pavyzdžiui, su Composer susietose
konfigūracijose, šią komandą naudokite, kad pašalintumėte tvarkingai. Konfigūracijos failai neliečiami.