Siirry sisältöön

CLI

Blockstudio rekisteröi WP-CLI-komennot lohkojen, tiedostopohjaisten sivujen, tietokantatietueiden, RPC-funktioiden, cron-töiden, asetusten ja WPML-kielimäärityksen hallintaan päätteen kautta.

Lohkot

Luettele kaikki lohkot

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

Rajaa vain komponentteihin

Shell
wp bs blocks list --components

Tulosta muodossa JSON

Shell
wp bs blocks list --format=json

Tallennettujen kenttien tarkistus

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

Tarkistaa määritettyjen julkaisujen tallennetun sisällön, myös sisäkkäiset innerBlocks, käyttäen bs_validate_block(). Se ei renderöi lohkoja, laajenna synkronoitujen mallien viittauksia eikä muokkaa julkaisuja. Tuntemattomat lohkot, joilla ei ole Blockstudio-laajennuksia, ohitetaan.

Oletustaulukossa luetellaan julkaisun tunnus, lohkopolku nollasta alkaen, lohkon nimi, löydöskoodi, kenttäpolku, lähde ja viesti. JSON sisältää lisäksi alkuperäiset value– ja expected-arvot. Sisäkkäisen lohkon lohkopolku voi olla 0/1 ja kenttäpolku cards/2/style; nämä ovat erillisiä polkuja.

Komento päättyy koodilla 0, kun löydöksiä ei ole, ja koodilla 1, kun niitä on. JSON-tuloste on pelkkä luettelo, joka sisältää myös [] onnistumisen yhteydessä, joten automaatio voi lukea sen myös silloin, kun komento päättyy koodilla 1. Puuttuvat julkaisut, puuttuvat tunnukset ja muut kuin table– tai json-muodot ovat virheitä. Kaikki tunnukset tarkistetaan ennen validoinnin aloittamista.

Lohkojen renderöinti

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

Renderöi rekisteröidyt lohkot samalla tavalla kuin sivu ja ilmoittaa jokaisesta PHP-huomautuksesta, varoituksesta, vanhentuneeksi merkitsemisestä ja lohkojen mallien aiheuttamasta poikkeuksesta. Teema voi suorittaa komennon CI:ssä testatakseen lohkonsa asennetun Blockstudio-version kanssa. Jos nimiä ei anneta, renderöidään kaikki rekisteröidyt lohkot, myös komponentit.

Kukin lohko renderöidään do_blocks()-toiminnolla lohkokommentista, jossa on blockstudio.attributes eli editorin tallentama rakenne, WP-CLIn frontend-kontekstissa eikä lisäysvalikon esikatselussa. Renderöintiä varten ei alusteta kyselyjulkaisua. Dynaamiset osat renderöivät varsinaisen mallisisältönsä pelkän paikkamerkin sijaan, eikä satunnainen mallien tuloste päädy raporttiin.

Komento ei itse tallenna julkaisuja tai kenttäarvoja, mutta se suorittaa mallisi ja renderöintikoukkuasi tavallisina PHP-toimintoina. Ne voivat kirjoittaa tietoja, kutsua ulkoisia palveluja tai aiheuttaa muita sivuvaikutuksia. Suorita komento luotetulla koodilla erillisellä testisivustolla; se ei ole vain luku -tilassa toimiva eristysympäristö.

Renderöinnin määritteet valitaan lohko kerrallaan:

Tapaus Määritteet
example Lohkon example.attributes-arvot, joita block.json sisältää; näitä arvoja lisäysvalikon esikatselu käyttää.
defaults Kunkin kentän default. Käytetään lohkoille, joilla ei ole example.attributes-arvoja; komento tulostaa rivin jokaisesta.
attributes --attributes-arvot korvaavat esimerkin.

--attributes ottaa vastaan JSON-objektin, jonka kenttäarvot on indeksoitu tallennusavaimilla, tai @-arvon ja sitä sisältävän tiedoston polun. Lisäksi tarvitaan täsmälleen yksi lohkon nimi. Käytä tätä mallin haarojen, joita esimerkki ei kata, kuten muunnelman, testaamiseen. Esimerkkiarvot, joilla luodaan vain paikkamerkkikuvia lisäysvalikon esikatseluun, ohitetaan, eikä esimerkin innerBlocks renderöidä.

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

Taulukossa on yksi rivi kutakin ongelmaa kohti. JSON-tuloste on luettelo renderöidyistä lohkoista, jossa on yksi merkintä kutakin lohkoa kohti, myös ongelmattomista lohkoista. Näin automaatio voi lukea, mitä tapausta käytettiin:

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 on Notice, Warning, Deprecated tai Error. Samassa tiedostossa ja rivillä toistuva ongelma, esimerkiksi silmukassa, ilmoitetaan kerran lohkoa kohti. @-toiminnolla hiljennettyjä ongelmia ei ilmoiteta. WordPress tuottaa omat vanhentumisilmoituksensa, kuten _deprecated_function()n ilmoitukset, vain kun WP_DEBUG on käytössä.

Komento päättyy koodilla 0, kun ongelmia ei löydy, ja muuten koodilla 1. Tuntemattomat lohkojen nimet, lukukelvottomat tai virheelliset --attributes-arvot sekä muut kuin table– tai json-muodot ovat virheitä. Kaikki nimet tarkistetaan ennen ensimmäisen lohkon renderöintiä.

Sivut

Tiedostopohjaisten sivujen synkronointi on eksplisiittistä. Tavalliset WordPress-pyynnöt eivät koskaan etsi kaikkia sivuja eivätkä kirjoita sivuviestejä. Kylmä ajonaikainen ympäristö voi lukea kokoelman manifestit kerran reittien palauttamiseksi ilman sisällön synkronointia.

Shell
wp bs pages sync

Komento täsmäyttää koko halutun sivuluettelon ja raportoi löydetyt, luodut, päivitetyt, muuttumattomat, lukitut, sisällöltään säilytetyt, poistetut ja epäonnistuneet sivut. Samanlaiset tiivisteet eivät aiheuta julkaisun tai post-metatietojen kirjoituksia.

Taulukkotulosteessa luetellaan muuttuneet, lukitut, sisällöltään säilytetyt ja poistetut sivut sekä niiden julkaisutunnukset. JSON sisältää pages.<name>.preserved-, pages.<name>.overwritten– ja removedPages-merkinnät, joissa annetaan sivun nimi, avain, julkaisun tunnus ja siivoustoiminto. Avaimilla tehtävän yhdistämisen jälkeen samanlainen julkaisu ilmoitetaan muuttumattomana luomatta versiota tai päivittämättä muokkausaikaleimaa.

Olemassa olevat julkaisutilat säilytetään; tiedoston omistamien otsikon ja polkutunnuksen korvaamisista tulostetaan varoitukset. Katso Kenttien omistajuus julkaisuissa.

Käytä --authoritative-valintaa hallitun sisällön korvaamiseen avainpohjaisen editorisisällön säilyttämisen sijaan ja --full-valintaa, kun haluat ilmoittaa ajon olevan täysi täsmäytys tallennetusta lähdetunnisteesta riippumatta. Kummassakin tapauksessa jokainen ajo vertaa koko luetteloa:

Shell
wp bs pages sync --authoritative --full

Käytä tätä käyttöönoton komentosarjoissa, jotka tarvitsevat koko raportin:

Shell
wp bs pages sync --format=json

Jokaiselta komennon jäsentämältä sivulta tarkistetaan attribuutit, jotka sen lohkot tallentavat mutta joita ne eivät koskaan tulosta: attribuutit, joita Blockstudio-lohko ei määrittele kentäksi eikä välitä juurielementilleen, kuten määrittelemätön class. Taulukkomuotoisessa ulostulossa näytetään varoitus jokaisesta sivusta ja lohkosta, dropped-sarake laskee ne, ja JSON-raportti luettelee ne kohdassa pages.<name>.droppedAttributes. Sivut, joiden lähde ei ole muuttunut, jäsennetään uudelleen vasta muutoksen yhteydessä tai ensimmäisessä synkronoinnissa jäsentimen muuttavan päivityksen jälkeen.

Komento päättyy virheeseen, jos löytämisessä tai täsmäytyksessä ilmenee virhe. Katso Sivut: PHP API ja käyttöönoton tunnisteen sopimusehdot.

Tietokanta

Luettele skeemat

Shell
wp bs db schemas
Koodi
+-------------------+-------------+---------+---------------------+
| 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-toiminnot

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

Yhden skeeman lohkoissa skeeman oletusnimi on default:

Shell
wp bs db list my-theme/leads

Siirrä JSONC-tietueet kohteeseen Storh

Käytä komentoa migrate, kun skeemalla on jo db/{schema}.jsonc-tiedosto ja haluat siirtää sen tietueet Storh-tiedostotaustajärjestelmään:

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

Yhden skeeman lohkoille:

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

Komento säilyttää kokonaislukumuotoiset tietuetunnisteet, kirjoittaa kohteeseen uploads/blockstudio/db/{block-scope}/{schema}/, rakentaa Storh-indeksit, tarkistaa kohdetallennuksen ja jättää lähteen .jsonc-tiedoston paikalleen.

Tulostusmuodot

Kaikki luettelokomennot tukevat muotoja --format=table (oletus), --format=json ja --format=csv:

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

RPC

Luettele kaikki funktiot

Shell
wp bs rpc list
Koodi
+-------------------+-------------+--------+----------------+---------+
| 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|
+-------------------+-------------+--------+----------------+---------+

Kutsu funktiota

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

Tuloste on muodossa JSON:

JSON
{
  "success": true
}

Parametrit välitetään --key=value-lippuina:

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

Cron

Luettele kaikki työt

Shell
wp bs cron list
Koodi
+-------------------+----------+----------+---------------------+
| 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 |
+-------------------+----------+----------+---------------------+

Suorita työ manuaalisesti

Shell
wp bs cron run my-theme/app cleanup

Tämä suorittaa takaisinkutsun välittömästi aikataulusta riippumatta. Hyödyllinen testaukseen ja virheenkorjaukseen.

Asetukset

Näytä kaikki asetukset

Shell
wp bs settings list

Hae yksittäinen asetus

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

Tailwind

Käännä HTML muotoon CSS

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

Käännä tiedostosta

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

Välimuistin hallinta

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

SCSS

Käännä SCSS muotoon CSS

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

Käännä tiedostosta

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

Mukautetut kentät

Luettele kaikki rekisteröidyt mukautetut kentät

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

Aineistot

Luettele kaikki resurssit

Shell
wp bs assets list

Rajaa tyypin mukaan

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

Komentosarjat

Kaikki komennot tukevat --format=json-valintaa putkitusta varten:

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

Content Sync

Content Sync vie sallittujen listalla olevan WordPress-sisällön tiedostoihin ja soveltaa nämä tiedostot takaisin tietokantaan. Toiminto on eksplisiittinen ja CLI-ohjattu; se ei synkronoi sivun latauksen tai ylläpidon alustuksen yhteydessä.

Katso Content Sync: määritykset, tiedostomuoto ja ohjeet siihen, milloin tiedostopohjainen tietokantasisältö sopii käyttöön.

Nouda tietokannan sisältö tiedostoihin

Shell
wp bs content pull

Rajaa nouto yhteen määritettyyn viestityyppiin tai taksonomiaan:

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

Esikatsele kirjoittamatta UID-tunnisteita tai tiedostoja:

Shell
wp bs content pull --dry-run

Vie tiedostot tietokantaan

Shell
wp bs content push

Esikatsele soveltamissuunnitelma kirjoittamatta:

Shell
wp bs content push --dry-run

Poista sisältöjoukon omistamat tietokantaviestit ja termit, joita ei enää ole tiedostoissa:

Shell
wp bs content push --prune --yes

Kun käytössä on --prune, Blockstudio soveltaa ensin kaikki tiedostomuutokset ja poistaa sitten sisältöjoukon omistamat entiteetit, joita ei enää ole tiedostoissa. Tuhoava poisto suoritetaan vain, jos --yes on annettu.

Tarkista tila

Shell
wp bs content status

Taulukossa kunkin tiedostopohjaisen entiteetin tilaksi ilmoitetaan unchanged, would-update, missing-db, conflict, locked tai orphaned.

Staattinen esihahmonnus

Katso Staattinen esihahmonnus itse välimuistista; nämä komennot ohjaavat sitä.

Lämmitä vanhentuneet merkinnät

Shell
wp bs prerender warm

Lisää vanhentuneet julkiset URL-osoitteet jonoon, hahmontaa sitten uudelleen enintään warm.concurrency työtä pysyvästä lämmitysjonosta ja tulostaa JSON-yhteenvedon, jossa on määrät: queued, processed, warmed, skipped ja failed. Sisällön ja sivuston muutokset lisäävät automaattisesti korvaavia töitä jonoon. Suorita komento uudelleen tai anna ajastetun lämmittäjän käsitellä suurempi jono; jos URL-kohteen hahmonnus epäonnistuu, sisältö pysyy vanhentuneena ja se lisätään jonoon seuraavalla ajokerralla. Tilassa graph sivustokohtainen URL- lämmittäjä ei ole käytössä eikä komento lisää mitään jonoon.

Raportoi välimuistin tila

Shell
wp bs prerender status

Raportoi aktiivisen tunnisteen, tiedostot, tavut, graafitietueet, jonon tilan, varhaisen tarjoilun karttaraportin sekä aluekohtaiset osuma-, ohitus-, rakentamis- ja virhelaskurit.

Tyhjennä välimuisti

Shell
wp bs prerender purge

Poistaa nykyisen sivuston esihahmonnetut dokumentit. Seuraava anonyymi pyyntö tai lämmitysajo rakentaa ne uudelleen.

Tarkista ja siivoa varhaisen tarjoilun kartta

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

map status raportoi koko asennuksen varhaisen tarjoilun kartan: sen merkinnät ja reitit, puuttuvat reittidokumentit, olemattomiin sivustoihin viittaavat orphaned-merkinnät sekä hakemiston katoamisesta kertovat dead-merkinnät. map prune poistaa orvot ja vanhentuneet merkinnät ja tulostaa jokaisen poistetun merkinnän syineen; --dry-run tulostaa saman raportin kirjoittamatta mitään. Toisen työkalun omistamaan karttaan ei kosketa.

WPML

Kielimäärityksen luominen

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

Tulostaa wpml-config.xml-määrityksen, joka ilmoittaa jokaisen rekisteröidyn lohkon tekstikentät käännettäviksi ja tiedostokentät liitetunnuksiksi, tai kirjoittaa sen toiminnolla --file. Olemassa olevasta tiedostosta korvataan vain osio, joka on merkkien Blockstudio välissä. Katso WPML, mitä määritykseen sisältyy ja miten tiedosto pidetään ajan tasalla.

Lohkotunnisteiden migraatio

Erillinen komentosarja muuntaa etuliite- ja aliaslyhenteet kanoniseksi <bs:namespace-slug>-kirjoitusasuksi. Se ei lataa WordPress-toimintoa eikä kirjoita mitään, ellei --apply-valintaa anneta nimenomaisesti:

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

Etuliitetiedosto yhdistää kutsujan omistamat etuliitteet järjestettyihin nimiavaruuksiin. Tunnettujen lohkojen tiedosto on rekisteröityjen lohkojen nimien JSON-luettelo. Tarkat aliakset ovat valinnaisia. Raportti sisältää deterministiset yhdistämiset, ennen- ja jälkeen-tiivisteet, tuntemattomat tunnisteet, monitulkintaiset aliakset, dynaamiset tunnisteet ja esimerkit, joita löytyi kommenteista, koodiaidoista, <pre>– tai <code>-jaksoista.

Jäsennin käsittelee parilliset, sisäkkäiset ja itsestään sulkeutuvat merkinnät, mukaan lukien kirjaimelliset tunnisteet PHP-merkkijonoissa. Se säilyttää attribuutit ja muuttaa vain tunnisteiden nimet. Kommentit ja koodiesimerkit lisätään vain raporttiin. Muut mukautetut elementit ohitetaan. Migraation soveltaminen estetään, jos tuntemattomia, monitulkintaisia tai dynaamisia tapauksia on jäljellä, ellei kutsuja anna tarkoituksella --allow-unresolved-valintaa. Komennon suorittaminen uudelleen kanonisen tulosteen perusteella ei aiheuta muutoksia.

Katso Migraatio: miksi kanoninen kirjoitusasu on olemassa ja mitä se ratkaisee.

Purkaminen

Shell
wp bs teardown

Poistaa asennuksen omistamat cron-tapahtumat ja staattisen esihahmonnuksen tilan: nykyisen sivuston varhaisen tarjoilun karttamerkinnän sekä jaetun advanced-cache.php -lisäosan ja WP_CACHE-määrityksen, kun viimeinen omistettu merkintä on poistettu. Tätä käytetään siistiin poistamiseen asennuksissa, joissa ei ole lisäosan käytöstäpoistotoimintoa, kuten Composer-paketoiduissa kokoonpanoissa. Määritystiedostot jätetään ennalleen.