Ga naar de inhoud

CLI

Blockstudio registreert WP-CLI-opdrachten voor het beheren van blokken, bestandsgestuurde pagina’s, databaserecords, RPC-functies, cron-taken, instellingen en de taalconfiguratie WPML vanuit de terminal.

Blokken

Alle blokken weergeven

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

Alleen componenten filteren

Shell
wp bs blocks list --components

Uitvoer als JSON

Shell
wp bs blocks list --format=json

Opgeslagen velden valideren

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

Controleert de opgeslagen inhoud van de opgegeven post-ID’s, inclusief geneste innerBlocks, met behulp van bs_validate_block(). De opdracht rendert geen blokken, vouwt geen verwijzingen naar gesynchroniseerde patronen uit en wijzigt geen posts. Onbekende blokken zonder extensies Blockstudio worden overgeslagen.

De standaardtabel vermeldt de post-ID, het nulgebaseerde blokpad, de bloknaam, de bevindingcode, het veldpad, de bron en het bericht. JSON bevat ook de oorspronkelijke waarden value en expected. Een genest blok kan het blokpad 0/1 en het veldpad cards/2/style hebben; dit zijn afzonderlijke paden.

De opdracht wordt afgesloten met 0 als er geen bevindingen zijn en met 1 als die er wel zijn. JSON-uitvoer is een gewone lijst, met ook [] bij succes, zodat automatisering het kan uitlezen, zelfs wanneer de opdracht wordt afgesloten met 1. Ontbrekende posts, ontbrekende ID’s en andere indelingen dan table of json zijn fouten. Alle ID’s worden gecontroleerd voordat de validatie begint.

Blokken renderen

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

Rendert geregistreerde blokken zoals een pagina dat doet en rapporteert elke PHP-melding, waarschuwing, verouderingsmelding en opgeworpen fout van hun templates. Een thema kan de opdracht in CI uitvoeren om de blokken te testen met de geïnstalleerde Blockstudio. Zonder opgegeven namen worden alle geregistreerde blokken gerenderd, inclusief componenten.

Elk blok wordt gerenderd via do_blocks(), vanuit een blokcommentaar met blockstudio.attributes, de vorm die de editor opslaat, in de frontendcontext van WP-CLI in plaats van het voorbeeld in de invoeger. Er wordt geen opgevraagde post klaargezet voor het renderen. Dynamische eilanden renderen hun echte template-inhoud in plaats van alleen hun plaatsaanduiding, en toevallige template-uitvoer wordt buiten het rapport gehouden.

De opdracht slaat zelf geen posts of veldwaarden op, maar voert je templates en renderhooks uit als gewone PHP. Ze kunnen gegevens schrijven, externe diensten aanroepen of andere neveneffecten hebben. Voer de opdracht uit met vertrouwde code op een speciale testsite; het is geen alleen-lezen sandbox.

De attributen voor een render worden per blok gekozen:

Geval Attributen
example De example.attributes van de block.json van het blok: de waarden die voorbeeld in de invoeger gebruikt.
defaults De default van elk veld. Gebruikt voor blokken zonder example.attributes; de opdracht drukt voor elk veld een regel af.
attributes De waarden van --attributes, ter vervanging van het voorbeeld.

--attributes accepteert een object JSON met veldwaarden, gesleuteld op opslagkey, of @ en het pad naar een bestand dat zo’n object bevat, en vereist precies één bloknaam. Gebruik dit om templatevertakkingen te bereiken die het voorbeeld niet toont, zoals een variant. Voorbeeldwaarden die alleen plaatsaanduidingsafbeeldingen genereren in het voorbeeld in de invoeger worden overgeslagen, en innerBlocks uit het voorbeeld worden niet gerenderd.

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

De tabel bevat één rij per probleem. JSON-uitvoer is een lijst met één item per gerenderd blok, ook voor blokken zonder problemen, zodat automatisering kan uitlezen welk geval is gebruikt:

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 is Notice, Warning, Deprecated of Error. Een probleem dat op hetzelfde bestand en dezelfde regel terugkomt, bijvoorbeeld in een lus, wordt eenmaal per blok gerapporteerd. Problemen die zijn onderdrukt met @ worden niet gerapporteerd. WordPress genereert zelf verouderingsmeldingen, zoals die van _deprecated_function(), alleen wanneer WP_DEBUG is ingeschakeld.

De opdracht wordt afgesloten met 0 als er geen problemen zijn gevonden en anders met 1. Onbekende bloknamen, onleesbare of ongeldige --attributes en andere indelingen dan table of json zijn fouten; alle namen worden gecontroleerd voordat het eerste blok wordt gerenderd.

Pagina’s

Synchronisatie van pagina’s op basis van bestanden is expliciet. Gewone WordPress-verzoeken voeren nooit een volledige paginadetectie uit en schrijven geen pagina-items. Een koude runtime kan collectiemanifesten één keer lezen om routes te herstellen, zonder inhoud te synchroniseren.

Shell
wp bs pages sync

De opdracht verzoent de volledige gewenste inventaris en rapporteert ontdekte, aangemaakte, bijgewerkte, ongewijzigde, vergrendelde, behouden, verwijderde en mislukte pagina’s. Gelijke vingerafdrukken leiden niet tot post- of post-meta-schrijfbewerkingen.

De tabeluitvoer vermeldt gewijzigde, vergrendelde, inhoudelijk behouden en verwijderde pagina’s, met hun post-ID’s. JSON bevat pages.<name>.preserved-, pages.<name>.overwritten– en removedPages-items met de paginanaam, key, post-ID en opruimactie. Een identieke post na samenvoegen op basis van keys wordt als ongewijzigd vermeld, zonder een revisie aan te maken of de wijzigingstijd bij te werken.

Bestaande publicatiestatussen blijven behouden; vervangingen van titel en slug die door bestanden worden beheerd, worden als waarschuwingen weergegeven. Zie Eigenaarschap van postvelden.

Gebruik --authoritative om beheerde inhoud te vervangen in plaats van inhoud van de editor met sleutels te behouden, en --full om de uitvoering als een volledige afstemming te rapporteren, ongeacht de opgeslagen bronidentiteit. Bij elke uitvoering wordt de volledige inventaris vergeleken:

Shell
wp bs pages sync --authoritative --full

Voor implementatiescripts die het volledige rapport nodig hebben:

Shell
wp bs pages sync --format=json

Elke pagina die de opdracht parseert, wordt gecontroleerd op attributen die de blokken opslaan maar nooit weergeven: attributen die een blok van Blockstudio niet als veld definieert en niet doorgeeft aan het root-element, zoals een niet-gedefinieerde class. De tabeluitvoer geeft per pagina en blok een waarschuwing; de kolom dropped telt ze, en het rapport JSON vermeldt ze onder pages.<name>.droppedAttributes. Pagina’s waarvan de bron niet is gewijzigd, worden niet opnieuw geparseerd. Ze worden dus gerapporteerd wanneer ze de volgende keer veranderen, of bij de eerste synchronisatie na een upgrade die de parser wijzigt.

De opdracht eindigt met een foutstatus wanneer detectie of afstemming een fout meldt. Zie Pagina’s voor de overeenkomst over PHP API en implementatie-identiteit.

Database

Schema’s weergeven

Shell
wp bs db schemas
Code
+-------------------+-------------+---------+---------------------+
| 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-bewerkingen

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

Voor blokken met één schema is de standaard schemanaam default:

Shell
wp bs db list my-theme/leads

JSONC-records migreren naar Storh

Gebruik migrate als een schema al een db/{schema}.jsonc-bestand heeft en je deze records naar de bestandsbackend Storh wilt verplaatsen:

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

Voor blokken met één schema:

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

De opdracht behoudt gehele record-ID’s, schrijft naar uploads/blockstudio/db/{block-scope}/{schema}/, bouwt Storh-indexen opnieuw op, controleert de doelopslag en laat het bronbestand .jsonc staan.

Uitvoerformaten

Alle opdrachten om lijsten weer te geven ondersteunen --format=table (standaard), --format=json en --format=csv:

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

RPC

Alle functies weergeven

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

Een functie aanroepen

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

De uitvoer is JSON:

JSON
{
  "success": true
}

Parameters worden doorgegeven als --key=value-vlaggen:

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

Cron

Alle taken weergeven

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

Een taak handmatig uitvoeren

Shell
wp bs cron run my-theme/app cleanup

Hiermee wordt de callback onmiddellijk uitgevoerd, ongeacht het schema. Handig voor testen en debuggen.

Instellingen

Alle instellingen weergeven

Shell
wp bs settings list

Een specifieke instelling ophalen

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

Tailwind

HTML compileren naar CSS

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

Compileren vanuit een bestand

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

Cachebeheer

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

SCSS

SCSS compileren naar CSS

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

Compileren vanuit een bestand

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

Aangepaste velden

Alle geregistreerde aangepaste velden weergeven

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

Assets

Alle assets weergeven

Shell
wp bs assets list

Filteren op 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 opdrachten ondersteunen --format=json om eenvoudig uitvoer door te sturen:

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 schrijft toegestane WordPress-inhoud in projecten naar bestanden en past die bestanden toe op de database. Dit gebeurt expliciet en wordt gestuurd door CLI; er wordt niets gesynchroniseerd bij het laden van een pagina of tijdens de initialisatie van de beheeromgeving.

Zie Content Sync voor configuratie, bestandsindeling en advies over wanneer database-inhoud op basis van bestanden goed past.

Database-inhoud naar bestanden ophalen

Shell
wp bs content pull

Beperk het ophalen tot één geconfigureerd berichttype of één taxonomie:

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

Voorbeeld bekijken zonder UID’s of bestanden te schrijven:

Shell
wp bs content pull --dry-run

Bestanden naar de database pushen

Shell
wp bs content push

Bekijk het plan voor toepassing zonder gegevens te schrijven:

Shell
wp bs content push --dry-run

Verwijder databaseberichten en -termen die eigendom zijn van de contentset en niet meer in bestanden voorkomen:

Shell
wp bs content push --prune --yes

Met --prune past Blockstudio eerst alle bestandswijzigingen toe en verwijdert daarna entiteiten die eigendom zijn van de contentset en niet meer in de bestanden voorkomen. De opdracht voert geen destructieve opschoning uit tenzij --yes is opgegeven.

Status controleren

Shell
wp bs content status

De tabel rapporteert elke bestandsgebaseerde entiteit als unchanged, would-update, missing-db, conflict, locked of orphaned.

Statische prerendering

Zie Statische prerendering voor de cache zelf; deze opdrachten sturen de werking ervan aan.

Verouderde items opwarmen

Shell
wp bs prerender warm

Zet verouderde openbare URL’s in de wachtrij, rendert vervolgens maximaal warm.concurrency taken opnieuw vanuit de duurzame opwarmwachtrij en geeft een overzicht van JSON met aantallen voor queued, processed, warmed, skipped en failed. Wijzigingen in inhoud en site zetten automatisch vervangende taken in de wachtrij. Voer de opdracht opnieuw uit of laat de geplande opwarmer een grotere wachtrij verwerken. Een URL die niet kan worden gerenderd, blijft verouderd en wordt bij de volgende uitvoering opnieuw in de wachtrij gezet. In de modus graph is de opwarmer per URL uitgeschakeld en zet de opdracht niets in de wachtrij.

Cachestatus rapporteren

Shell
wp bs prerender status

Rapporteert de actieve identiteit, bestanden, bytes, grafiekrecords, wachrijstatus, het rapport over vroeg serveren en de tellers voor hits, missers, builds en fouten per scope.

De cache legen

Shell
wp bs prerender purge

Verwijdert de prerendered documenten van de huidige site. Het volgende anonieme verzoek of de volgende opwarmronde bouwt ze opnieuw op.

De kaart voor vroeg serveren controleren en opschonen

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

map status rapporteert de installatiebrede kaart voor vroeg serveren: de items en routes, routdocumenten die ontbreken, orphaned-items waarvan de site niet meer bestaat en dead-items waarvan de map is verdwenen. map prune verwijdert wees- en inactieve items en toont elk verwijderd item met de reden; --dry-run toont hetzelfde rapport zonder iets te schrijven. Een kaart van een ander hulpmiddel wordt nooit aangepast.

WPML

De taalconfiguratie genereren

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

Drukt een wpml-config.xml af waarin de tekstvelden van elk geregistreerd blok voor vertaling worden opgegeven en de bestandsvelden als bijlage-ID’s, of schrijft deze met --file. In een bestaand bestand wordt alleen de sectie tussen de markeringen Blockstudio vervangen. Zie WPML voor wat wordt opgegeven en hoe je het bestand actueel houdt.

Migratie van bloktags

Een zelfstandig script herschrijft prefix- en aliasafkortingen naar de canonieke spelling <bs:namespace-slug>. Het laadt WordPress niet en schrijft niets weg tenzij --apply expliciet wordt opgegeven:

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

Het prefixbestand koppelt door de gebruiker beheerde prefixes aan geordende naamruimten. Het bestand met bekende blokken is een JSON-lijst van geregistreerde bloknamen. Exacte aliassen zijn optioneel. Het rapport bevat deterministische koppelingen, hashes van voor en na, onbekende tags, ambigue aliassen, dynamische tags en voorbeelden in opmerkingen, codeblokken, bereiken <pre> of <code>.

De scanner verwerkt gekoppelde, geneste en zelfsluitende markup, inclusief letterlijke tags in PHP-strings. Attributen blijven behouden; alleen tagnamen worden gewijzigd. Opmerkingen en codevoorbeelden worden alleen gerapporteerd. Niet-gerelateerde aangepaste elementen worden genegeerd. Een migratie kan niet worden toegepast zolang onbekende, ambigue of dynamische gevallen bestaan, tenzij de gebruiker bewust --allow-unresolved doorgeeft. Als de opdracht opnieuw op canonieke uitvoer wordt uitgevoerd, worden er geen wijzigingen aangebracht.

Zie Migratie voor uitleg over de canonieke spelling en wat daarmee wordt opgelost.

Verwijderen

Shell
wp bs teardown

Verwijdert de cron-gebeurtenissen en de statische prerenderstatus die een installatie beheert: de vermelding van de huidige site op de kaart voor vroeg serveren, en de gedeelde advanced-cache.php– drop-in en WP_CACHE-declaratie zodra de laatste beheerde vermelding is verdwenen. Installaties zonder een deactiveringshook van een plugin, zoals opstellingen met Composer-bundels, gebruiken dit voor een schone verwijdering. Configuratiebestanden blijven ongemoeid.