Ugrás a tartalomhoz

CLI

A Blockstudio a terminálból használható WP-CLI parancsokat regisztrál blokkok, fájlalapú oldalak, adatbázisrekordok, RPC függvények, cron feladatok, beállítások és a WPML nyelvi konfiguráció kezelésére.

Blokkok

Az összes blokk listázása

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

Szűrés csak komponensekre

Shell
wp bs blocks list --components

Kimenet JSON formátumban

Shell
wp bs blocks list --format=json

Tárolt mezők ellenőrzése

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

Ellenőrzi a megadott bejegyzésazonosítók tárolt tartalmát, beleértve a beágyazott innerBlocks elemeket is, a bs_validate_block() használatával. Nem rendereli a blokkokat, nem bontja ki a szinkronizált mintákra mutató hivatkozásokat, és nem módosítja a bejegyzéseket. A Blockstudio bővítmény nélküli, ismeretlen blokkok kimaradnak.

Az alapértelmezett táblázat a bejegyzésazonosítót, a blokk nullától számozott útvonalát, a blokk nevét, a hibakódot, a mező útvonalát, a forrást és az üzenetet sorolja fel. A JSON az eredeti value és expected értékeket is tartalmazza. Egy beágyazott blokk útvonala lehet 0/1, mezőjének útvonala pedig cards/2/style; ez a két útvonal különbözik.

A parancs 0 értékkel lép ki, ha nem talál hibát, és 1 értékkel, ha talál. A JSON kimenet egyszerű lista, amely siker esetén is tartalmazza a [] értéket, így automatizálásban akkor is feldolgozható, ha a parancs 1 értékkel lép ki. A hiányzó bejegyzések, azonosítók, valamint a table-től és json-től eltérő formátumok hibának számítanak. Az ellenőrzés megkezdése előtt minden azonosítót ellenőriz.

Blokkok renderelése

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

Úgy rendereli a regisztrált blokkokat, ahogyan egy oldal tenné, és jelenti a sablonjaik által kiváltott minden PHP értesítést, figyelmeztetést, elavulási jelzést és kivételt. Egy téma CI-folyamatban futtathatja a parancsot, hogy gyors ellenőrzéssel tesztelje blokkjait a telepített Blockstudio rendszerrel. Ha nem ad meg neveket, minden regisztrált blokk renderelődik, beleértve a komponenseket is.

Minden blokk renderelése do_blocks() használatával, egy blockstudio.attributes attribútummal ellátott blokkkommentárból történik; ez az a forma, amelyet a szerkesztő tárol, WP-CLI kezelőfelületének frontend környezetében, nem pedig a beszúró előnézetében. A rendereléshez nem állít be lekérdezett bejegyzést. A dinamikus szigetek a valódi sablontörzsüket renderelik, nem csak a helyőrzőjüket, a járulékos sablonkimenet pedig nem kerül a jelentésbe.

A parancs önmagában nem ment bejegyzéseket vagy mezőértékeket, de a sablonokat és renderelési hookokat szokásos PHP környezetként futtatja. Ezek adatokat írhatnak, külső szolgáltatásokat hívhatnak meg, vagy más mellékhatással járhatnak. Megbízható kódon, erre kijelölt tesztoldalon futtassa; ez nem írásvédett sandbox.

A renderelés attribútumai blokkonként kerülnek kiválasztásra:

Eset Attribútumok
example A blokk block.json értékének example.attributes része, vagyis azok az értékek, amelyeket a beszúró előnézete használ.
defaults Minden mező default értéke. Olyan blokkokhoz használatos, amelyeknek nincs example.attributes értékük; a parancs mindegyikhez külön sort ír ki.
attributes A --attributes értékei, amelyek az példát helyettesítik.

A --attributes egy JSON objektumot vár, amelyben a mezőértékek tárolási kulcs szerint vannak megadva, vagy a @ értéket és egy azt tartalmazó fájl elérési útját; emellett pontosan egy blokknév szükséges. Ezzel olyan sablonágakat is elérhet, amelyeket a példa nem fed le, például egy változatot. A beszúró előnézetében csak helyőrző képeket generáló példaértékek kimaradnak, és a példa innerBlocks elemei nem renderelődnek.

Kód
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| 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    |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+

A táblázat problémánként egy sort tartalmaz. A JSON kimenet renderelt blokkonként egy bejegyzést tartalmazó lista, a problémamentes blokkokat is beleértve, így az automatizálás feldolgozhatja a használt esetet:

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

A level értéke lehet Notice, Warning, Deprecated vagy Error. Ha egy probléma ugyanabban a fájlban, ugyanazon a soron ismétlődik, például egy ciklusban, blokkonként egyszer jelenik meg a jelentésben. A @ használatával elnémított problémák nem jelennek meg. A WordPress csak akkor jelenti a saját elavulási értesítéseit, például a _deprecated_function() értesítéseit, ha a WP_DEBUG engedélyezve van.

A parancs 0 értékkel lép ki, ha nem talál problémát, egyébként pedig 1 értékkel. Az ismeretlen blokknevek, a nem olvasható vagy érvénytelen --attributes értékek, valamint a table-tól és json-től eltérő formátumok hibának számítanak; az első blokk renderelése előtt minden nevet ellenőriz.

Oldalak

A fájlalapú oldalak szinkronizálása kifejezett művelet. A szokásos WordPress kérések nem derítik fel az összes oldalt, és nem írnak oldalbejegyzéseket. A hideg futtatókörnyezet egyszer beolvashatja a gyűjteményjegyzékeket az útvonalak helyreállításához, tartalomszinkronizálás nélkül.

Shell
wp bs pages sync

A parancs összeveti és érvényesíti a teljes kívánt leltárt, majd jelentést készít a felderített, létrehozott, frissített, változatlan, zárolt, megőrzött, eltávolított és sikertelen oldalakról. Az egyező ujjlenyomatok nem eredményeznek bejegyzés- vagy bejegyzés-meta írást.

A táblázatos kimenet megnevezi a módosult, zárolt, tartalmukban megőrzött és eltávolított oldalakat, valamint feltünteti a bejegyzésazonosítójukat. A JSON tartalmazza a pages.<name>.preserved, pages.<name>.overwritten és removedPages bejegyzéseket is, az oldal nevével, kulcsával, bejegyzésazonosítójával és a tisztítási művelettel együtt. Azonos, kulcsok szerinti összevonás után kapott bejegyzés változatlanként jelenik meg; nem jön létre új verzió, és a módosítás időbélyege sem lép előre.

A meglévő közzétételi állapotok megmaradnak; a fájl által kezelt cím- és slugcserék figyelmeztetésként jelennek meg. Lásd: Bejegyzésmezők tulajdonjoga.

A --authoritative segítségével lecserélheti a kezelt tartalmat a kulcsokhoz rendelt szerkesztői helyett, a --full segítségével pedig a tárolt forrásazonosságtól függetlenül teljes egyeztetésként jelentheti a futást. Mindkét esetben a teljes leltár kerül összehasonlításra:

Shell
wp bs pages sync --authoritative --full

A teljes jelentést igénylő telepítési szkriptekhez:

Shell
wp bs pages sync --format=json

A parancs minden feldolgozott oldalon ellenőrzi azokat az attribútumokat, amelyeket a blokkok tárolnak, de soha nem jelenítenek meg: ilyenek például azok az attribútumok, amelyeket egy Blockstudio blokk sem mezőként nem deklarál, sem a gyökérelemnek nem ad tovább, például egy nem deklarált class. A táblázatos kimenet oldalanként és blokkonként figyelmeztetést ír ki, a dropped oszlop pedig összesíti ezeket, a JSON jelentés pedig a pages.<name>.droppedAttributes alatt sorolja fel őket. Azok az oldalak, amelyek forrása nem változott, nem kerülnek újra feldolgozásra; a jelentésben akkor jelennek meg, amikor legközelebb módosulnak, vagy az elemzőt módosító frissítést követő első szinkronizáláskor.

A parancs sikertelen kilépési állapotot ad vissza, ha a felderítés vagy az egyeztetés hibát jelez. Lásd: Oldalak a PHP API és a telepítési azonosság szerződését.

Adatbázis

Sémák listázása

Shell
wp bs db schemas
Kód
+-------------------+-------------+---------+---------------------+
| 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-műveletek

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

Az egyetlen sémát használó blokkoknál a séma neve alapértelmezés szerint default:

Shell
wp bs db list my-theme/leads

JSONC rekordok migrálása ide: Storh

Használja a migrate parancsot, ha egy sémához már tartozik db/{schema}.jsonc fájl, és rekordjait át szeretné helyezni a Storh fájlalapú háttérrendszerbe:

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

Egyetlen sémát használó blokkok esetén:

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

A parancs megőrzi az egész számú rekordazonosítókat, ide ír: uploads/blockstudio/db/{block-scope}/{schema}/, újraépíti a Storh indexeket, ellenőrzi a céladat-tárolót, és a forrás .jsonc fájlt a helyén hagyja.

Kimeneti formátumok

Minden listázó parancs támogatja a következőket: --format=table (alapértelmezett), --format=json és --format=csv:

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

RPC

Az összes függvény listázása

Shell
wp bs rpc list
Kód
+-------------------+-------------+--------+----------------+---------+
| 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|
+-------------------+-------------+--------+----------------+---------+

Függvény meghívása

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

A kimenet JSON:

JSON
{
  "success": true
}

A paramétereket --key=value kapcsolókkal kell átadni:

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

Cron

Az összes feladat listázása

Shell
wp bs cron list
Kód
+-------------------+----------+----------+---------------------+
| 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 |
+-------------------+----------+----------+---------------------+

Feladat manuális futtatása

Shell
wp bs cron run my-theme/app cleanup

Ez azonnal végrehajtja a visszahívást, az ütemezéstől függetlenül. Hasznos teszteléshez és hibakereséshez.

Beállítások

Az összes beállítás megjelenítése

Shell
wp bs settings list

Egy adott beállítás lekérése

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

Tailwind

HTML fordítása erre: CSS

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

Fordítás fájlból

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

Gyorsítótár kezelése

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

SCSS

SCSS fordítása erre: CSS

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

Fordítás fájlból

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

Egyéni mezők

Az összes regisztrált egyéni mező listázása

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

Erőforrások

Az összes eszköz listázása

Shell
wp bs assets list

Szűrés típus szerint

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

Szkriptelés

Minden parancs támogatja a --format=json használatát az egyszerű továbbításhoz:

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

A Content Sync projektjei az engedélyezőlistán szereplő WordPress tartalmat fájlokba exportálják, majd ezeket a fájlokat alkalmazzák az adatbázisra. A folyamat kifejezett, és CLI vezérli; oldalbetöltéskor vagy az adminisztrációs felület inicializálásakor nem szinkronizál.

A konfigurációról, a fájlformátumról és arról, hogy mikor érdemes az adatbázis tartalmát fájlokban tárolni, lásd a Content Sync oldalt.

Adatbázis-tartalom lekérése fájlokba

Shell
wp bs content pull

Korlátozza a lekérést egy konfigurált bejegyzéstípusra vagy taxonómiára:

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

Előnézet UID-k vagy fájlok írása nélkül:

Shell
wp bs content pull --dry-run

Fájlok feltöltése az adatbázisba

Shell
wp bs content push

Az alkalmazási terv előnézete írás nélkül:

Shell
wp bs content push --dry-run

Törölje azokat a tartalomkészlet által kezelt adatbázis-bejegyzéseket és kifejezéseket, amelyek már nem szerepelnek a fájlokban:

Shell
wp bs content push --prune --yes

A --prune használatakor a Blockstudio először alkalmazza az összes fájlmódosítást, majd eltávolítja azokat a tartalomkészlet által kezelt entitásokat, amelyek már nem szerepelnek a fájlokban. A romboló törlés futtatása előtt megköveteli a --yes jelenlétét.

Állapot ellenőrzése

Shell
wp bs content status

A táblázat minden fájlalapú entitás állapotát a következő értékek egyikeként jelzi: unchanged, would-update, missing-db, conflict, locked vagy orphaned.

Statikus előzetes renderelés

Magáról a gyorsítótárról lásd a Statikus előzetes renderelés oldalt; ezekkel a parancsokkal kezelheti.

Elavult bejegyzések felmelegítése

Shell
wp bs prerender warm

Sorba állítja az elavult nyilvános URL-eket, majd újrarenderel legfeljebb warm.concurrency feladatot a tartós felmelegítési sorból, és JSON összesítést jelenít meg queued, processed, warmed, skipped és failed darabszámmal. A tartalom és a webhely változásai automatikusan új feladatokat állítanak sorba. Futtassa újra a parancsot, vagy várja meg az ütemezett felmelegítést a nagyobb sor feldolgozásához; a renderelés során sikertelen URL elavult marad, és a következő futáskor ismét sorba kerül. graph módban az egyes URL elemek felmelegítése ki van kapcsolva, és a parancs nem állít sorba semmit.

Gyorsítótár állapotának jelentése

Shell
wp bs prerender status

Jelenti az aktív azonosságot, fájlokat, bájtokat, gráfrekordokat, a sor állapotát, a korai kiszolgálás térképének jelentését, valamint az egyes hatókörök találati/hiányzási/építési/hibaszámlálóit.

Gyorsítótár ürítése

Shell
wp bs prerender purge

Eltávolítja az aktuális webhely előzetesen renderelt dokumentumait. A következő névtelen kérés vagy felmelegítési futás újraépíti őket.

A korai kiszolgálás térképének ellenőrzése és ritkítása

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

A map status a telepítés egészére kiterjedő korai kiszolgálási térképről készít jelentést: felsorolja a bejegyzéseket és útvonalakat, a hiányzó útvonal-dokumentumokat, a már nem létező webhelyhez tartozó orphaned bejegyzéseket, valamint azokat a dead bejegyzéseket, amelyek könyvtára megszűnt. A map prune eltávolítja az árva és érvénytelen bejegyzéseket, és indoklással együtt kiírja mindegyiket; a --dry-run írás nélkül jeleníti meg ugyanezt a jelentést. Más eszköz által kezelt térképhez nem nyúl.

WPML

A nyelvi konfiguráció létrehozása

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

Kiír egy wpml-config.xml konfigurációt, amely minden regisztrált blokk szövegmezőit fordítandóként, fájlmezőit pedig mellékletazonosítóként deklarálja, vagy a --file használatával fájlba írja. Meglévő fájl esetén csak a Blockstudio jelölők közötti szakaszt cseréli le. A WPML ismerteti, hogy mi kerül deklarálásra, és hogyan tartható naprakészen a fájl.

Blokkcímke-migráció

Az önálló szkript a prefix- és alias-rövidítéseket a kanonikus <bs:namespace-slug> alakra írja át. Nem tölti be a WordPress elemet, és nem ír, kivéve, ha kifejezetten meg van adva a --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

A prefixfájl a hívó által megadott prefixeket rendezetten hozzárendeli a névterekhez. Az ismert blokkok fájlja a regisztrált blokkok neveinek rendezett JSON listája. A pontos aliasok megadása nem kötelező. A jelentés determinisztikus megfeleltetéseket, előtte és utána készült hashértékeket, ismeretlen címkéket, kétértelmű aliasokat, dinamikus címkéket, valamint a megjegyzésekben, kódblokkokban, <pre> vagy <code> tartományokban talált példákat tartalmazza.

A beolvasó kezeli a párosított, egymásba ágyazott és önzáró jelöléseket, beleértve a PHP karakterláncokban szereplő szó szerinti címkéket is. Megőrzi az attribútumokat, és csak a címkeneveket módosítja. A megjegyzések és kódminták csak a jelentésben szerepelnek. A nem kapcsolódó egyéni elemeket figyelmen kívül hagyja. A migráció alkalmazása blokkolva van, amíg ismeretlen, kétértelmű vagy dinamikus esetek maradnak, kivéve, ha a hívó szándékosan megadja a --allow-unresolved értéket. A parancs újbóli futtatása a kanonikus kimeneten nem okoz változást.

A kanonikus alak eredetéről és az általa megoldott problémáról lásd a Migráció oldalt.

Eltávolítás

Shell
wp bs teardown

Eltávolítja a cron eseményeket és azokat a statikus előzetes renderelési állapotokat, amelyeket a telepítés kezel: az aktuális webhely korai kiszolgálási térképének bejegyzését, valamint a megosztott advanced-cache.php kiegészítő modult és a WP_CACHE deklarációt, ha már nincs több kezelt bejegyzés. Ezt használhatják a bővítmény-deaktiválási hook nélküli telepítések, például a Composer csomagba foglalt összeállítások a tiszta eltávolításhoz. A konfigurációs fájlokat érintetlenül hagyja.