Liigu sisu juurde

CLI

Blockstudio registreerib WP-CLI käsud plokkide, failipõhiste lehtede, andmebaasikirjete, RPC funktsioonide, cron tööde, seadete ja WPML keelekonfiguratsiooni haldamiseks terminalist.

Plokid

Kõigi plokkide loend

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

Ainult komponentide filtreerimine

Shell
wp bs blocks list --components

Väljund kui JSON

Shell
wp bs blocks list --format=json

Salvestatud väljade valideerimine

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

Kontrollib määratud postituste ID-de salvestatud sisu, sealhulgas pesastatud innerBlocks, kasutades bs_validate_block(). See ei renderda plokke, ei ava sünkroonitud mustrite viiteid ega muuda postitusi. Tundmatud plokid, millel puuduvad Blockstudio laiendused, jäetakse vahele.

Vaiketabelis on postituse ID, nullist algav plokitee, ploki nimi, leiu kood, väljatee, allikas ja teade. JSON sisaldab ka algseid väärtusi value ja expected. Pesastatud ploki plokitee võib olla 0/1 ja väljatee cards/2/style; need on eraldi teed.

Kui leide pole, lõpeb käsk koodiga 0, leidude korral koodiga 1. JSON väljund on lihtne loend, mis sisaldab õnnestumise korral ka kirjet [], nii et automaatika saab seda lugeda ka siis, kui käsu lõppkood on 1. Puuduvad postitused või ID-d ning vormingud peale table või json põhjustavad vea. Kõik ID-d kontrollitakse enne valideerimise alustamist.

Plokkide renderdamine

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

Renderdab registreeritud plokke nii nagu lehel ning teatab igast märkusest PHP, hoiatusest, aegumisest ja erindist, mille nende mallid tekitavad. Teema saab käivitada käsu CI-s, et kontrollida oma plokke installitud Blockstudio-i vastu. Kui nimesid ei anta, renderdatakse kõik registreeritud plokid, sealhulgas komponendid.

Iga plokk renderdatakse do_blocks() kaudu plokikommentaarist, millel on blockstudio.attributes ehk kuju, mille redaktor salvestab, WP-CLIi esikülje kontekstis, mitte lisaja eelvaates. Renderdamiseks ei seadistata päringuga postitust. Dünaamilised saared renderdavad oma tegeliku malli sisu, mitte ainult kohatäitjat, ning juhuslik malliväljund jäetakse aruandest välja.

Käsk ise postitusi ega väljaväärtusi ei salvesta, kuid käivitab teie mallid ja renderdamise hook’id nagu tavaline PHP. Need võivad kirjutada andmeid, helistada välistele teenustele või põhjustada muid kõrvalmõjusid. Käivitage see usaldusväärse koodiga spetsiaalsel testsaidil; see pole kirjutuskaitstud liivakast.

Renderduse atribuudid valitakse iga ploki jaoks eraldi:

Juht Atribuudid
example Ploki block.json example.attributes ehk väärtused, mida kasutab lisaja eelvaade.
defaults Iga välja default. Kasutatakse plokkide puhul, millel puudub example.attributes; käsk väljastab igaühe kohta rea.
attributes --attributes väärtused asendavad näite.

--attributes võtab välja salvestusvõtme järgi indekseeritud väärtustega JSON objekti või @ ja seda sisaldava faili tee ning vajab täpselt üht ploki nime. Kasutage seda malliharude saavutamiseks, mida näide ei kata, näiteks variandi puhul. Näidisväärtused, mis loovad lisaja eelvaates ainult kohatäitja pilte, jäetakse vahele ning näite innerBlocks ei renderdata.

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

Tabelis on üks rida probleemi kohta. JSON väljund on loend, milles on üks kirje renderdatud ploki kohta, sealhulgas probleemideta plokkide kohta, nii et automaatika saab lugeda, millist juhtumit kasutati:

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 või Error. Kui probleem kordub samas failis ja real, näiteks tsüklis, teatatakse sellest iga ploki kohta üks kord. @-ga vaigistatud probleemidest ei teatata. WordPress tekitab oma aegumisteated, näiteks _deprecated_function() omi, ainult siis, kui WP_DEBUG on lubatud.

Kui probleeme ei leita, lõpeb käsk koodiga 0, muul juhul koodiga 1. Tundmatud plokinimed, loetamatu või vigane --attributes ning vormingud peale table või json põhjustavad vea; kõik nimed kontrollitakse enne esimese ploki renderdamist.

Lehed

Failipõhiste lehtede sünkroonimine toimub selgesõnaliselt. Tavalised WordPress päringud ei avasta kõiki lehti ega kirjuta lehe postitusi. Külma käivitusega käituskeskkond võib marsruutide taastamiseks üks kord kollektsiooni manifestid läbi lugeda, kuid sisu ei sünkrooni.

Shell
wp bs pages sync

Käsk kooskõlastab täieliku soovitud loendi ja teatab leitud, loodud, uuendatud, muutmata, lukustatud, säilitatud, eemaldatud ja nurjunud lehtedest. Ühesugused sõrmejäljed ei põhjusta postituse ega post meta kirjutamist.

Tabeliväljund nimetab muudetud, lukustatud, sisult säilitatud ja eemaldatud lehed koos nende postituste ID-dega. JSON sisaldab ka kirjeid pages.<name>.preserved, pages.<name>.overwritten ja removedPages koos lehe nime, võtme, postituse ID ja puhastustoiminguga. Pärast võtmete järgi ühendamist identse postituse kohta teatatakse kui muutmata postitusest, ilma et loodaks revisjon või muudetaks selle muutmise ajatemplit.

Olemasolevad avaldamisolekud säilitatakse; failipõhise pealkirja ja püsiviida asendamine väljastatakse hoiatustena. Vaadake jaotist Postiväljade omandiõigus.

Kasutage --authoritative, et asendada hallatav sisu võtmetega seotud redaktori sisu säilitamise asemel, ja --full, et teatada käivitusest kui täielikust kooskõlastusest, olenemata salvestatud lähteidentiteedist. Iga käivitus võrdleb mõlemal juhul kogu loendit:

Shell
wp bs pages sync --authoritative --full

Täielikku aruannet vajavate juurutusskriptide jaoks:

Shell
wp bs pages sync --format=json

Iga käsuga parsitava lehe puhul kontrollitakse atribuute, mille plokid salvestavad, kuid kunagi ei kuva: atribuudid, mida Blockstudio plokk ei deklareeri väljana ega edasta juurelemendile, näiteks deklareerimata class. Tabeliväljund kuvab iga lehe ja ploki kohta hoiatuse, veerg dropped loendab need ning aruanne JSON loetleb need jaotises pages.<name>.droppedAttributes. Lehti, mille lähteandmed pole muutunud, uuesti ei parsita, seega kuvatakse need järgmisel muudatuskorral või esimesel sünkroonimisel pärast parserit muutvat uuendust.

Avastamise või kooskõlastamise vea korral lõpetab käsk ebaõnnestumisega. Lugege jaotist Lehed, kus kirjeldatakse PHP API ja juurutuse identiteedilepingut.

Andmebaas

Skeemide loend

Shell
wp bs db schemas
Kood
+-------------------+-------------+---------+---------------------+
| 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-toimingud

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

Ühe skeemiga plokkide puhul on skeemi vaikenimi default:

Shell
wp bs db list my-theme/leads

Kirjete migreerimine JSONC-ist Storh-i

Kasutage migrate, kui skeemil on juba db/{schema}.jsonc-fail ja soovite teisaldada need kirjed failipõhisesse taustsüsteemi Storh:

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

Ühe skeemiga plokkide puhul:

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

Käsk säilitab täisarvulised kirje-ID-d, kirjutab asukohta uploads/blockstudio/db/{block-scope}/{schema}/, loob uuesti Storh indeksid,\nkontrollib sihtandmehoidlat ja jätab lähtefaili .jsonc alles.

Väljundvormingud

Kõik loendikäsud toetavad vorminguid --format=table (vaikimisi), --format=json ja --format=csv:

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

RPC

Kõigi funktsioonide loend

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

Funktsiooni väljakutsumine

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

Väljund on JSON:

JSON
{
  "success": true
}

Parameetrid antakse edasi lippudena --key=value:

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

Cron

Kõigi tööde loend

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

Töö käsitsi käivitamine

Shell
wp bs cron run my-theme/app cleanup

See käivitab tagasihelistuse kohe, ajakavast olenemata. Kasulik testimiseks ja silumiseks.

Seaded

Kõigi seadete kuvamine

Shell
wp bs settings list

Kindla sätte hankimine

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

Tailwind

Kompileeri HTML kujule CSS

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

Kompileerimine failist

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

Vahemälu haldamine

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

SCSS

Kompileeri SCSS kujule CSS

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

Kompileerimine failist

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

Kohandatud väljad

Kõigi registreeritud kohandatud väljade loend

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

Varad

Kõigi varade loend

Shell
wp bs assets list

Tüübi järgi filtreerimine

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

Skriptimine

Kõik käsud toetavad lihtsaks torustamiseks suvandit --format=json:

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

Sisu sünkroonimise projektid ekspordivad lubatud WordPress-sisu failidesse ja rakendavad need failid andmebaasi. See on selgesõnaline ja CLI-põhine; sünkroonimist ei toimu lehe laadimisel ega halduskeskkonna lähtestamisel.

Lugege jaotist Sisu sünkroonimine, kus on teave seadistamise, failivormingu ja juhiste kohta, millal failipõhine andmebaasisisu sobib.

Andmebaasi sisu tõmbamine failidesse

Shell
wp bs content pull

Piirake tõmbamine ühe seadistatud postitusetüübi või taksonoomiaga:

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

Eelvaade ilma UID-de või failide kirjutamiseta:

Shell
wp bs content pull --dry-run

Failide saatmine andmebaasi

Shell
wp bs content push

Rakendusplaani eelvaade ilma kirjutamiseta:

Shell
wp bs content push --dry-run

Kustutage sisukogumile kuuluvad andmebaasi postitused ja terminid, mida failides enam pole:

Shell
wp bs content push --prune --yes

Suvandiga --prune rakendab Blockstudio esmalt kõik failimuudatused, seejärel eemaldab sisukogumile kuuluvad üksused, mida failides enam pole. Hävitavat kärpimist ei käivitata, kui puudub --yes.

Olekukontroll

Shell
wp bs content status

Tabel näitab iga failipõhise üksuse olekuna unchanged, would-update, missing-db, conflict, locked või orphaned.

Staatiline eeltöötlus

Vaadake vahemälu enda kohta teavet jaotisest Staatiline eeltöötlus; need käsud juhivad seda.

Aegunud kirjete soojendamine

Shell
wp bs prerender warm

Lisab aegunud avalikud URL-id püsivasse soojendusjärjekorda, renderdab sealt kuni warm.concurrency tööd ning kuvab kokkuvõtte JSON loenditega: queued, processed, warmed, skipped ja failed. Sisu- ja saidimuudatused lisavad automaatselt asendustööd. Suurema järjekorra töötlemiseks käivitage käsk uuesti või laske ajastatud soojendajal seda teha. Kui URL renderdamine ebaõnnestub, jääb see aegunuks ja lisatakse järgmisel käivitamisel uuesti järjekorda. Režiimis graph on URL-põhine soojendaja välja lülitatud ja käsk ei lisa järjekorda midagi.

Vahemälu olekuaruanne

Shell
wp bs prerender status

Annab aru aktiivsest identiteedist, failidest, baitidest, graafikirjetest, järjekorra olekust, varase teenindamise kaardi aruandest ning ulatusepõhistest tabamuste, möödalaskmiste, koostamiste ja tõrgete loenduritest.

Vahemälu tühjendamine

Shell
wp bs prerender purge

Eemaldab praeguse saidi eeltöödeldud dokumendid. Järgmine anonüümne päring või soojenduskäik loob need uuesti.

Varase teenindamise kaardi kontroll ja kärpimine

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

map status annab aru installiülesest varase teenindamise kaardist: selle kirjetest ja marsruutidest, puuduvatest marsruudidokumentidest, kirjetest orphaned, mille saiti pole enam olemas, ning kirjetest dead, mille kataloog on kadunud. map prune eemaldab eraldiseisvad ja kasutud kirjed ning prindib iga eemaldatud kirje koos põhjusega; --dry-run kuvab sama aruande midagi kirjutamata. Teisele tööriistale kuuluvat kaarti ei muudeta kunagi.

WPML

Keelekonfiguratsiooni loomine

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

Väljastab wpml-config.xml, mis määrab iga registreeritud ploki tekstiväljad tõlkimiseks ja failiväljad manuse ID-dena, või kirjutab selle käsuga --file. Olemasolevas failis asendatakse ainult Blockstudio markerite vaheline jaotis. Vaadake jaotist WPML, et teada saada, mis määratakse ja kuidas faili ajakohasena hoida.

Plokisiltide migreerimine

Eraldiseisev skript asendab eesliite ja aliase lühivormid kanoonilise kirjapildiga <bs:namespace-slug>. See ei laadi WordPress ega kirjuta midagi, kui pole selgesõnaliselt antud suvandit --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

Eesliitefail seostab helistaja hallatavad eesliited järjestatud nimeruumidega. Tuntud plokkide fail on registreeritud plokkide nimede loend JSON. Täpsed aliased on valikulised. Aruanne sisaldab deterministlikke seoseid, enne ja pärast räsi, tundmatuid silte, mitmetähenduslikke aliaseid, dünaamilisi silte ja kommentaarides, koodiplokkides, <pre> või <code> vahemikes leitud näiteid.

Skanner käsitleb paaris, pesastatud ja isesulguvat märgendust, sealhulgas sõnasõnalisi silte stringides PHP. See säilitab atribuudid ja muudab ainult siltide nimesid. Kommentaarid ja koodinäited lisatakse ainult aruandesse. Seoseta kohandatud elemendid eiratakse. Migreerimine on blokeeritud, kuni alles on tundmatuid, mitmetähenduslikke või dünaamilisi juhte, välja arvatud juhul, kui helistaja lisab sihilikult suvandi --allow-unresolved. Kui käsku käitatakse uuesti kanoonilise väljundi peal, muudatusi ei teki.

Lugege jaotist Migreerimine, et teada saada, miks kanooniline kirjapilt olemas on ja mida see lahendab.

Eemaldamine

Shell
wp bs teardown

Eemaldab installi hallatavad cron sündmused ja staatilise eeltöötluse oleku: praeguse saidi varase teenindamise kaardi kirje ning ühiskasutatava advanced-cache.php laienduse ja WP_CACHE deklaratsiooni, kui viimane hallatav kirje on kadunud. Installid, millel puudub plugina inaktiveerimise konks (näiteks Composer-komplektiga seadistused), saavad selle abil puhtalt eemalduda. Seadistusfailid jäävad puutumata.