Gå til indhold

CLI

Blockstudio registrerer WP-CLI-kommandoer til administration af blokke, filbaserede sider, databaseposter, RPC-funktioner, cron-jobs, indstillinger og WPML-sprogkonfigurationen fra terminalen.

Blokke

Vis alle blokke

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

Filtrer, så kun komponenter vises

Shell
wp bs blocks list --components

Output som JSON

Shell
wp bs blocks list --format=json

Valider gemte felter

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

Kontrollerer det gemte indhold for de angivne indlægs-id’er, herunder indlejrede innerBlocks, ved hjælp af bs_validate_block(). Kommandoen renderer ikke blokke, udvider ikke referencer til synkroniserede mønstre og ændrer ikke indlæg. Ukendte blokke uden udvidelser af typen Blockstudio springes over.

Standardtabellen viser indlægs-id, bloksti med nulbaseret indeks, bloknavn, fundkode, feltsti, kilde og meddelelse. JSON indeholder også de oprindelige værdier for value og expected. En indlejret blok kan have blokstien 0/1 og feltstien cards/2/style; det er separate stier.

Kommandoen afsluttes med 0, hvis der ikke er fund, og 1, hvis der er fund. JSON-output er en almindelig liste, som også indeholder [] ved succes, så automatisering kan læse den, selv når kommandoen afsluttes med 1. Manglende indlæg, manglende id’er og andre formater end table eller json giver fejl. Alle id’er kontrolleres, før valideringen begynder.

Render blokke

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

Renderer registrerede blokke, som en side gør, og rapporterer hver eneste PHP-meddelelse, advarsel, forældelse og udløst fejl fra deres skabeloner. Et tema kan køre kommandoen i CI for at smoke-teste sine blokke mod den installerede Blockstudio. Uden angivne navne renderes alle registrerede blokke, herunder komponenter.

Hver blok renderes gennem do_blocks() ud fra en blokkommentar med blockstudio.attributes, den form editoren gemmer, i WP-CLIs frontendkontekst frem for inserterens forhåndsvisning. Der konfigureres ikke noget forespurgt indlæg til renderingen. Dynamiske øer renderer deres faktiske skabelonindhold i stedet for kun deres pladsholder, og uvedkommende skabelonoutput udelades fra rapporten.

Kommandoen gemmer ikke selv indlæg eller feltværdier, men den kører dine skabeloner og render-hooks som almindelige PHP. De kan skrive data, kalde eksterne tjenester eller have andre bivirkninger. Kør den mod betroet kode på et dedikeret testwebsted; den er ikke et skrivebeskyttet sandkassemiljø.

Attributterne for en rendering vælges for hver blok:

Tilfælde Attributter
example Blokkens example.attributes for block.json, de værdier, som forhåndsvisningen i indsætteren bruger.
defaults default for hvert felt. Bruges til blokke uden example.attributes; kommandoen udskriver en linje for hvert felt.
attributes Værdierne for --attributes, som erstatter eksemplet.

--attributes tager et JSON-objekt med feltværdier, hvor nøglerne er lagringsnøgler, eller @ samt stien til en fil, der indeholder et sådant objekt, og kræver præcis ét bloknavn. Brug det til at nå skabelongrene, som eksemplet ikke dækker, f.eks. en variant. Eksempelværdier, der kun genererer pladsholderbilleder i forhåndsvisningen hos indsætteren, springes over, og innerBlocks fra eksemplet renderes ikke.

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

Tabellen viser én række pr. problem. JSON-output er en liste med én post pr. renderet blok, også blokke uden problemer, så automatisering kan se, hvilket tilfælde der blev brugt:

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 er Notice, Warning, Deprecated eller Error. Et problem, der gentages på samme fil og linje, f.eks. i en løkke, rapporteres én gang pr. blok. Problemer, der undertrykkes med @, rapporteres ikke. WordPress udløser sine egne forældelsesmeddelelser, f.eks. dem fra _deprecated_function(), kun når WP_DEBUG er aktiveret.

Kommandoen afsluttes med 0, når der ikke findes problemer, og ellers med 1. Ukendte bloknavne, ulæselige eller ugyldige --attributes og andre formater end table eller json giver fejl, og alle navne kontrolleres, før den første blok renderes.

Sider

Synkronisering af filbaserede sider er eksplicit. Almindelige WordPress-anmodninger udfører aldrig fuld sideopdagelse eller skriver sideindlæg. En kold runtime kan læse samlingsmanifester én gang for at gendanne ruter uden at synkronisere indhold.

Shell
wp bs pages sync

Kommandoen afstemmer den komplette ønskede fortegnelse og rapporterer sider, der er fundet, oprettet, opdateret, uændrede, låste, bevarede, fjernede og fejlslagne. Identiske fingeraftryk medfører ingen skrivninger til indlæg eller indlægsmetadata.

Tabeloutput angiver ændrede, låste, indholdsbevarede og fjernede sider med deres indlægs-id’er. JSON indeholder poster af typen pages.<name>.preserved, pages.<name>.overwritten og removedPages med sidenavn, nøgle, indlægs-id og oprydningshandling. Et identisk indlæg efter nøglebaseret sammenfletning rapporteres som uændret uden at oprette en revision eller ændre tidspunktet for seneste ændring.

Eksisterende publiceringsstatusser bevares; udskiftninger af titel og slug, som ejes af filen, udskrives som advarsler. Se Ejerskab af indlægsfelter.

Brug --authoritative til at erstatte administreret indhold i stedet for at bevare nøglebaseret redaktørindhold, og --full til at rapportere kørslen som en fuld afstemning, uanset den gemte kildeidentitet. Hver kørsel sammenligner hele beholdningen på begge måder:

Shell
wp bs pages sync --authoritative --full

Til implementeringsscripts, der har brug for den fulde rapport:

Shell
wp bs pages sync --format=json

Hver side, som kommandoen analyserer, kontrolleres for attributter, som dens blokke gemmer, men aldrig gengiver: attributter, som en Blockstudio-blok hverken erklærer som et felt eller videresender til sit rodelement, f.eks. en ikke-erklæret class. Tabeloutputtet viser en advarsel for hver side og blok, kolonnen dropped tæller dem, og rapporten JSON viser dem under pages.<name>.droppedAttributes. Sider, hvis kilde ikke er ændret, analyseres ikke igen. De rapporteres derfor, næste gang de ændres, eller ved den første synkronisering efter en opgradering, der ændrer parseren.

Kommandoen afsluttes med fejlstatus, når opdagelse eller afstemning rapporterer en fejl. Se Sider for aftalen om PHP API og implementeringsidentitet.

Database

Vis skemaer

Shell
wp bs db schemas
Kode
+-------------------+-------------+---------+---------------------+
| 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-handlinger

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

For blokke med ét skema er skemanavnet som standard default:

Shell
wp bs db list my-theme/leads

Migrer JSONC-poster til Storh

Brug migrate, når et skema allerede har en db/{schema}.jsonc-fil, og du vil flytte posterne til filbackend’en Storh:

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

For blokke med ét skema:

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

Kommandoen bevarer heltals-ID’er for poster, skriver til uploads/blockstudio/db/{block-scope}/{schema}/, genopbygger Storh-indekser, bekræfter målageret og lader kildefilen .jsonc ligge.

Outputformater

Alle listekommandoer understøtter --format=table (standard), --format=json og --format=csv:

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

RPC

Vis alle funktioner

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

Kald en funktion

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

Output er JSON:

JSON
{
  "success": true
}

Parametre overføres som flag af typen --key=value:

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

Cron

Vis alle jobs

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

Kør et job manuelt

Shell
wp bs cron run my-theme/app cleanup

Dette udfører callback-funktionen med det samme, uanset tidsplanen. Nyttigt til test og fejlfinding.

Indstillinger

Vis alle indstillinger

Shell
wp bs settings list

Hent en bestemt indstilling

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

Tailwind

Kompilér HTML til CSS

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

Kompilér fra fil

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

Cacheadministration

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

SCSS

Kompilér SCSS til CSS

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

Kompilér fra fil

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

Brugerdefinerede felter

Vis alle registrerede brugerdefinerede felter

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

Ressourcer

Vis alle aktiver

Shell
wp bs assets list

Filtrer efter type

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

Scripting

Alle kommandoer understøtter --format=json, så output nemt kan sendes videre:

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 eksporterer tilladt WordPress-indhold til filer og anvender filerne på databasen igen. Det sker eksplicit og styres af CLI; synkronisering udføres ikke ved sideindlæsning eller initialisering af administrationen.

Se Content Sync for konfiguration, filformat og vejledning i, hvornår databaseindhold baseret på filer passer godt.

Hent databaseindhold til filer

Shell
wp bs content pull

Begræns hentningen til én konfigureret indlægstype eller taksonomi:

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

Forhåndsvisning uden at skrive UID’er eller filer:

Shell
wp bs content pull --dry-run

Send filer til databasen

Shell
wp bs content push

Forhåndsvis planen for anvendelsen uden at skrive:

Shell
wp bs content push --dry-run

Beskær databaseindlæg og termer, der ejes af indholdssættet, og som ikke længere findes i filer:

Shell
wp bs content push --prune --yes

Med --prune anvender Blockstudio først alle filændringer og fjerner derefter entiteter, der ejes af indholdssættet, og som ikke længere findes i filerne. Kommandoen nægter at udføre en destruktiv beskæring, medmindre --yes er angivet.

Kontrollér status

Shell
wp bs content status

Tabellen viser hver filbaseret entitet som unchanged, would-update, missing-db, conflict, locked eller orphaned.

Statisk prerendering

Se Statisk prerendering for selve cachen; disse kommandoer styrer den.

Opvarm forældede poster

Shell
wp bs prerender warm

Lægger forældede offentlige URL’er i kø, gengiver derefter op til warm.concurrency jobs fra den holdbare opvarmningskø og udskriver en JSON-oversigt med antal for queued, processed, warmed, skipped og failed. Ændringer af indhold og websted lægger automatisk erstatningsjobs i kø. Kør kommandoen igen, eller lad den planlagte opvarmer køre, for at behandle en større kø; en URL, der ikke kan gengives, forbliver forældet og sættes i kø igen ved næste kørsel. I tilstanden graph er opvarmeren pr. URL slået fra, og kommandoen lægger intet i kø.

Rapportér cachens tilstand

Shell
wp bs prerender status

Rapporterer den aktive identitet, filer, bytes, grafposter, køtilstand, rapporten over kortet til tidlig visning samt tællere for hits/misses/opbygninger/fejl pr. omfang.

Ryd cachen

Shell
wp bs prerender purge

Fjerner det aktuelle websteds prerenderede dokumenter. Den næste anonyme anmodning eller opvarmningskørsel opbygger dem igen.

Kontrollér og beskær kortet til tidlig visning

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

map status rapporterer kortet til tidlig visning for hele installationen: dets poster og ruter, rutens dokumenter, der mangler, orphaned-poster, hvis websted ikke længere findes, og dead-poster, hvis mappe er væk. map prune fjerner forældreløse og døde poster og udskriver hver fjernet post med årsagen; --dry-run udskriver den samme rapport uden at skrive. Et kort, der ejes af et andet værktøj, berøres aldrig.

WPML

Generér sprogkonfigurationen

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

Udskriver en wpml-config.xml, der angiver tekstfelterne for alle registrerede blokke til oversættelse og deres filfelter som vedhæftnings-id’er, eller skriver den med --file. I en eksisterende fil erstattes kun afsnittet mellem markørerne Blockstudio. Se WPML for at se, hvad der angives, og hvordan filen holdes opdateret.

Migrering af bloktags

Et selvstændigt script omskriver præfiks- og aliasforkortelser til den kanoniske <bs:namespace-slug>-stavemåde. Det indlæser ikke WordPress og skriver ikke, medmindre --apply angives eksplicit:

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

Præfiksfilen knytter præfikser, der ejes af kalderen, til ordnede navnerum. Filen med kendte blokke er en JSON-liste over registrerede bloknavne. Eksakte aliaser er valgfrie. Rapporten indeholder deterministiske tilknytninger, hashes før og efter, ukendte tags, tvetydige aliaser, dynamiske tags og eksempler fundet i kommentarer, kodeblokke, <pre>– eller <code>-områder.

Scanneren håndterer parrede, indlejrede og selvafsluttende markup-tags, herunder bogstavelige tags i PHP-strenge. Den bevarer attributter og ændrer kun tagnavne. Kommentarer og kodeeksempler vises kun i rapporten. Irrelevante brugerdefinerede elementer ignoreres. Migrering kan ikke anvendes, så længe der er ukendte, tvetydige eller dynamiske tilfælde, medmindre kalderen bevidst angiver --allow-unresolved. Hvis kommandoen køres igen på kanonisk output, sker der ingen ændringer.

Se Migrering for at læse, hvorfor den kanoniske stavemåde findes, og hvad den løser.

Afinstallation

Shell
wp bs teardown

Fjerner cron-hændelserne og den statiske prerenderingstilstand, som en installation ejer: den aktuelle sides post i kortet til tidlig visning og den delte advanced-cache.php-drop-in-fil samt erklæringen WP_CACHE, når den sidste ejede post er væk. Installationer uden et hook til deaktivering af plugin, f.eks. opsætninger med Composer samlet, bruger dette til en ren fjernelse. Konfigurationsfiler efterlades urørte.