CLI
Blockstudio mendaftarkan perintah WP-CLI untuk mengelola blok, halaman berbasis file, rekaman database, fungsi RPC, tugas cron, pengaturan, dan konfigurasi bahasa WPML dari terminal.
Blok
Tampilkan semua blok
wp bs blocks list
+----------------------------+---------------------+-----------+------------------------+
| name | title | component | category |
+----------------------------+---------------------+-----------+------------------------+
| my-theme/hero | Hero | | my-theme |
| my-theme/card | Card | yes | my-theme |
| my-theme/newsletter | Newsletter | | my-theme |
+----------------------------+---------------------+-----------+------------------------+
Filter hanya komponen
wp bs blocks list --components
Keluarkan sebagai JSON
wp bs blocks list --format=json
Validasi field yang tersimpan
wp bs blocks validate 42
wp bs blocks validate 42 57 --format=json
Memeriksa konten tersimpan dari ID kiriman yang ditentukan, termasuk
innerBlocks bertingkat, menggunakan bs_validate_block().
Perintah ini tidak merender blok, memperluas referensi pola tersinkronisasi, atau mengubah kiriman.
Blok yang tidak dikenal tanpa ekstensi Blockstudio akan dilewati.
Tabel default mencantumkan ID kiriman, jalur blok berbasis nol, nama blok,
kode temuan, jalur field, sumber, dan pesan. JSON juga menyertakan nilai
value dan expected yang asli. Blok bertingkat dapat memiliki jalur blok 0/1
dan jalur field cards/2/style; keduanya adalah jalur yang terpisah.
Perintah keluar dengan 0 jika tidak ada temuan dan 1 jika ada temuan.
Keluaran JSON berupa daftar biasa, termasuk [] saat berhasil, sehingga otomatisasi dapat
membacanya meskipun perintah keluar dengan 1. Kiriman tidak ditemukan, ID tidak ditemukan, dan
format selain table atau json merupakan kesalahan. Semua ID diperiksa sebelum
validasi dimulai.
Render blok
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
Merender blok terdaftar seperti yang dilakukan halaman dan melaporkan setiap notifikasi PHP, peringatan, deprekasi, dan error yang dilempar oleh templatnya. Tema dapat menjalankan perintah ini di CI untuk menguji bloknya secara singkat terhadap Blockstudio yang terpasang. Jika nama tidak ditentukan, semua blok terdaftar akan dirender, termasuk komponen.
Setiap blok dirender melalui do_blocks() dari komentar blok dengan
blockstudio.attributes, bentuk yang disimpan editor, dalam konteks frontend WP-CLI,
bukan pratinjau inserter. Tidak ada kiriman yang dikueri untuk proses render.
Pulau dinamis merender isi templat aslinya, bukan hanya placeholder-nya, dan keluaran templat yang tidak terkait tidak disertakan dalam laporan.
Perintah ini tidak menyimpan kiriman atau nilai field, tetapi menjalankan templat dan hook render Anda seperti PHP biasa. Keduanya dapat menulis data, memanggil layanan eksternal, atau menimbulkan efek samping lain. Jalankan pada kode tepercaya di situs uji khusus; perintah ini bukan sandbox hanya-baca.
Atribut render ditentukan untuk setiap blok:
| Kasus | Atribut |
|---|---|
example |
example.attributes dari block.json blok, nilai yang digunakan oleh pratinjau penyisip. |
defaults |
default setiap bidang. Digunakan untuk blok tanpa example.attributes; perintah mencetak satu baris untuk setiap bidang. |
attributes |
Nilai --attributes, menggantikan contoh. |
--attributes menerima objek JSON berisi nilai field dengan kunci berupa kunci penyimpanan, atau
@ dan jalur file yang memuatnya, serta membutuhkan tepat satu nama blok.
Gunakan ini untuk menjangkau cabang templat yang tidak dicakup oleh contoh, seperti
varian. Nilai contoh yang hanya menghasilkan gambar placeholder di pratinjau inserter
dilewati, dan innerBlocks dari contoh tidak dirender.
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| 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 |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
Tabel mencantumkan satu baris untuk setiap masalah. Keluaran JSON berupa daftar dengan satu entri untuk setiap blok yang dirender, termasuk blok tanpa masalah, sehingga otomatisasi dapat membaca kasus yang digunakan:
[
{
"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 adalah Notice, Warning, Deprecated, atau Error. Masalah yang
berulang pada file dan baris yang sama, misalnya dalam loop, dilaporkan satu kali per
blok. Masalah yang dibungkam dengan @ tidak dilaporkan. WordPress menampilkan notifikasi deprekasinya sendiri,
seperti notifikasi dari _deprecated_function(), hanya saat WP_DEBUG diaktifkan.
Perintah keluar dengan 0 jika tidak ditemukan masalah dan 1 jika sebaliknya. Nama blok yang tidak dikenal, --attributes yang tidak dapat dibaca atau tidak valid, serta format selain table atau json merupakan kesalahan, dan semua nama diperiksa sebelum blok pertama dirender.
Halaman
Sinkronisasi halaman berbasis file dilakukan secara eksplisit. Permintaan WordPress biasa tidak pernah melakukan penemuan halaman secara lengkap atau menulis entri halaman. Runtime yang baru dimulai dapat membaca manifes koleksi satu kali untuk memulihkan rute, tanpa menyinkronkan konten.
wp bs pages sync
Perintah ini merekonsiliasi seluruh inventaris yang diinginkan dan melaporkan halaman yang ditemukan, dibuat, diperbarui, tidak berubah, dikunci, dipertahankan, dihapus, dan gagal. Fingerprint yang sama tidak menghasilkan penulisan post atau post-meta.
Keluaran tabel mencantumkan halaman yang berubah, dikunci, dipertahankan kontennya, dan dihapus beserta ID post-nya. JSON menyertakan entri pages.<name>.preserved,
pages.<name>.overwritten, dan removedPages dengan nama halaman, kunci,
ID post, dan tindakan pembersihan. Post yang identik setelah penggabungan berdasarkan kunci dilaporkan
sebagai tidak berubah tanpa membuat revisi atau memperbarui stempel waktu modifikasinya.
Status publikasi yang ada tetap dipertahankan; penggantian judul dan slug yang dimiliki file dicetak sebagai peringatan. Lihat Kepemilikan Field Post.
Gunakan --authoritative untuk mengganti konten yang dikelola alih-alih mempertahankan
konten editor yang dikunci, dan --full untuk melaporkan proses sebagai rekonsiliasi penuh,
apa pun identitas sumber yang tersimpan. Setiap proses tetap membandingkan seluruh
inventaris:
wp bs pages sync --authoritative --full
Untuk skrip deployment yang memerlukan laporan lengkap:
wp bs pages sync --format=json
Setiap halaman yang diuraikan oleh perintah ini diperiksa untuk atribut yang disimpan oleh bloknya
tetapi tidak pernah dirender: atribut yang tidak dideklarasikan sebagai field
atau diteruskan ke elemen root oleh blok Blockstudio, seperti class yang tidak dideklarasikan. Kolom tabel
menampilkan peringatan untuk setiap halaman dan blok, kolom dropped menghitung jumlahnya,
dan laporan JSON mencantumkannya di bawah pages.<name>.droppedAttributes. Halaman
yang sumbernya tidak berubah tidak diuraikan lagi, sehingga dilaporkan saat berubah
berikutnya, atau pada sinkronisasi pertama setelah pemutakhiran yang mengubah pengurai.
Perintah ini berakhir dengan kegagalan jika penemuan atau rekonsiliasi melaporkan kesalahan. Lihat Halaman untuk kontrak PHP API dan identitas deployment.
Database
Tampilkan skema
wp bs db schemas
+-------------------+-------------+---------+---------------------+
| 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 |
+-------------------+-------------+---------+---------------------+
Operasi CRUD
# 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
Untuk blok dengan satu skema, nama skema secara default adalah default:
wp bs db list my-theme/leads
Migrasikan rekaman JSONC ke Storh
Gunakan migrate jika skema sudah memiliki file db/{schema}.jsonc dan Anda ingin
memindahkan rekaman tersebut ke backend file Storh:
wp bs db migrate my-theme/app subscribers --to=storh
Untuk blok dengan satu skema:
wp bs db migrate my-theme/app --to=storh
Perintah ini mempertahankan ID rekaman bilangan bulat, menulis ke
uploads/blockstudio/db/{block-scope}/{schema}/, membangun ulang indeks Storh,
memverifikasi penyimpanan target, dan membiarkan file .jsonc sumber tetap ada.
Format keluaran
Semua perintah daftar mendukung --format=table (default), --format=json, dan
--format=csv:
wp bs db list my-theme/app subscribers --format=json
RPC
Tampilkan semua fungsi
wp bs rpc list
+-------------------+-------------+--------+----------------+---------+
| 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|
+-------------------+-------------+--------+----------------+---------+
Panggil fungsi
wp bs rpc call my-theme/app subscribe --email=user@example.com
Keluaran berupa JSON:
{
"success": true
}
Parameter diberikan sebagai flag --key=value:
wp bs rpc call my-theme/app load_more --offset=10 --limit=5
Cron
Tampilkan semua tugas
wp bs cron list
+-------------------+----------+----------+---------------------+
| 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 |
+-------------------+----------+----------+---------------------+
Jalankan tugas secara manual
wp bs cron run my-theme/app cleanup
Ini langsung menjalankan callback, terlepas dari jadwalnya. Berguna untuk pengujian dan debugging.
Pengaturan
Tampilkan semua pengaturan
wp bs settings list
Ambil pengaturan tertentu
wp bs settings get tailwind/enabled
wp bs settings get assets/enqueue
Tailwind
Kompilasikan HTML ke CSS
wp bs tailwind compile '<div class="flex items-center p-4">'
Kompilasikan dari file
wp bs tailwind compile --file=template.html
Pengelolaan cache
wp bs tailwind cache path # show cache directory
wp bs tailwind cache clear # clear compiled cache
SCSS
Kompilasikan SCSS ke CSS
wp bs scss compile '$color: red; .test { color: $color; }'
Kompilasikan dari file
wp bs scss compile --file=styles.scss
Field Kustom
Tampilkan semua field kustom yang terdaftar
wp bs fields list
+-------+----------------+---------------------------+
| name | title | fields |
+-------+----------------+---------------------------+
| hero | Hero Section | heading, description, cta |
| card | Card | title, image, link |
+-------+----------------+---------------------------+
Aset
Tampilkan semua aset
wp bs assets list
Filter berdasarkan jenis
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
Semua perintah mendukung --format=json agar mudah diteruskan melalui pipe:
# 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
Proyek Content Sync memproyeksikan konten WordPress yang masuk daftar izin ke file dan menerapkan file tersebut kembali ke basis data. Prosesnya eksplisit dan digerakkan oleh CLI; sinkronisasi tidak dilakukan saat halaman dimuat atau admin diinisialisasi.
Lihat Content Sync untuk konfigurasi, format file, dan panduan tentang kapan konten basis data berbasis file cocok digunakan.
Tarik konten basis data ke file
wp bs content pull
Batasi penarikan ke satu jenis pos atau taksonomi yang dikonfigurasi:
wp bs content pull --post-type=team_member
wp bs content pull --taxonomy=category
Pratinjau tanpa menulis UID atau file:
wp bs content pull --dry-run
Dorong file ke basis data
wp bs content push
Pratinjau rencana penerapan tanpa menulis:
wp bs content push --dry-run
Pangkas pos dan istilah basis data milik set konten yang tidak lagi ada di file:
wp bs content push --prune --yes
Dengan --prune, Blockstudio menerapkan semua perubahan file terlebih dahulu, lalu menghapus entitas milik set konten yang tidak lagi ada di file. Perintah ini menolak pemangkasan yang destruktif kecuali --yes disertakan.
Periksa status
wp bs content status
Tabel melaporkan setiap entitas berbasis file sebagai unchanged, would-update, missing-db, conflict, locked, atau orphaned.
Prarender Statis
Lihat Prarender Statis untuk cache itu sendiri; perintah berikut mengelolanya.
Hangatkan entri usang
wp bs prerender warm
Masukkan URL publik yang usang ke antrean, lalu render ulang hingga warm.concurrency tugas dari antrean pemanasan persisten dan cetak ringkasan JSON dengan jumlah queued, processed,
warmed, skipped, dan failed. Perubahan konten dan situs otomatis memasukkan tugas pengganti ke antrean. Jalankan perintah lagi, atau biarkan pemanas terjadwal berjalan, untuk memproses antrean yang lebih besar; URL yang gagal dirender tetap usang dan dimasukkan kembali ke antrean pada proses berikutnya. Dalam mode graph, pemanas per-URL dinonaktifkan dan perintah ini tidak memasukkan apa pun ke antrean.
Laporkan status cache
wp bs prerender status
Melaporkan identitas aktif, file, byte, rekaman graf, status antrean, laporan peta penyajian awal, serta penghitung hit/miss/build/kegagalan per cakupan.
Bersihkan cache
wp bs prerender purge
Menghapus dokumen prarender situs saat ini. Permintaan anonim atau proses pemanasan berikutnya akan membangunnya kembali.
Periksa dan pangkas peta penyajian awal
wp bs prerender map status
wp bs prerender map prune --dry-run
wp bs prerender map prune
map status melaporkan peta penyajian awal untuk seluruh instalasi: entri dan
rutenya, dokumen rute yang hilang, entri orphaned yang situsnya sudah tidak
ada, dan entri dead yang direktorinya sudah hilang. map prune menghapus
entri yatim dan mati serta mencetak setiap entri yang dihapus beserta alasannya;
--dry-run mencetak laporan yang sama tanpa menulis apa pun. Peta yang dimiliki alat lain tidak pernah disentuh.
WPML
Buat konfigurasi bahasa
wp bs wpml config
wp bs wpml config --file=wp-content/themes/my-theme/wpml-config.xml
Mencetak wpml-config.xml yang mendeklarasikan field teks dari setiap blok terdaftar untuk penerjemahan dan field file-nya sebagai ID lampiran, atau menulisnya dengan --file. Dalam file yang sudah ada, hanya bagian di antara penanda Blockstudio yang diganti. Lihat WPML untuk mengetahui apa yang dideklarasikan dan cara menjaga file tetap mutakhir.
Migrasi Tag Blok
Skrip mandiri menulis ulang singkatan prefix dan alias menjadi ejaan kanonis
<bs:namespace-slug>. Skrip ini tidak memuat WordPress dan tidak menulis
kecuali --apply diberikan secara eksplisit:
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
File prefix memetakan prefix milik pemanggil ke namespace yang berurutan. File
blok yang dikenal berupa daftar JSON nama blok terdaftar. Alias persis bersifat
opsional. Laporan mencakup pemetaan deterministik, hash sebelum/sesudah,
tag yang tidak dikenal, alias ambigu, tag dinamis, dan contoh yang ditemukan dalam komentar,
blok kode, rentang <pre>, atau <code>.
Pemindai menangani markup berpasangan, bertingkat, dan menutup diri, termasuk tag literal
dalam string PHP. Atribut dipertahankan dan hanya nama tag yang diubah.
Komentar dan contoh kode hanya dilaporkan. Elemen kustom yang tidak terkait
diabaikan. Penerapan migrasi diblokir selama masih ada kasus yang tidak dikenal, ambigu, atau dinamis, kecuali pemanggil dengan sengaja memberikan --allow-unresolved.
Menjalankan perintah lagi pada keluaran kanonis tidak menghasilkan perubahan.
Lihat Migrasi untuk alasan penggunaan ejaan kanonis dan hal yang diselesaikannya.
Penghapusan
wp bs teardown
Menghapus event cron dan status prarender statis milik instalasi: entri peta penyajian awal situs saat ini, serta drop-in advanced-cache.php bersama dan deklarasi WP_CACHE setelah entri terakhir yang dimiliki dihapus.
Instalasi tanpa hook penonaktifan plugin, seperti penyiapan yang disertakan dalam Composer, menggunakan ini untuk penghapusan bersih. File konfigurasi tidak diubah.