Halaman lengkap, ditentukan dalam kode
Template dan Markdown, disinkronkan ke WordPress dengan satu perintah.
Koleksi dari file
Definisikan pages.json dan biarkan Blockstudio menemukan setiap sumber di dalamnya. Jalur bertingkat menjadi halaman bertingkat, nilai default berlaku untuk koleksi, dan halaman induk yang belum ada dapat dibuat secara otomatis.
Gunakan koleksi untuk dokumentasi, basis pengetahuan, atau halaman arahan, dan pasang folder eksternal di bawah prefiks jalur dengan loader.php.
Letakkan layout.php atau tata letak renderer seperti layout.tsx di samping pages.json untuk membungkus setiap halaman koleksi dalam satu shell, dengan blockstudio_page_tree() untuk sidebar.
{
"collection": "docs",
"title": "Documentation",
"postType": "bs_docs",
"defaults": {
"postStatus": "publish",
"templateLock": "contentOnly"
}
}---
title: Installation
order: 10
---
# Installation
Install Blockstudio from this Markdown page.<?php $current = blockstudio_current_page(); ?>
<main class="docs-layout">
<aside>
<?php foreach (blockstudio_page_tree('docs') as $item) : ?>
<?php $is_current = ($item['post_id'] ?? null) === ($current['post_id'] ?? null); ?>
<a
href="<?php echo esc_url($item['permalink'] ?? '#'); ?>"
<?php echo $is_current ? 'aria-current="page"' : ''; ?>
>
<?php echo esc_html($item['title']); ?>
</a>
<?php endforeach; ?>
</aside>
<article>
<?php echo blockstudio_page_content(); ?>
</article>
</main>Sinkronisasi eksplisit
wp bs pages sync menerapkan perubahan; halaman yang tidak berubah tidak memerlukan penulisan apa pun.
Sumber Markdown
Gunakan index.md dengan frontmatter atau pasangkan konten Markdown dengan page.json.
Markdown mentah
Halaman file Markdown disajikan di URL ditambah .md, atau di URL biasa untuk Accept: text/markdown, dengan tautan kanonis kembali ke HTML.
Loader koleksi
Pasang folder dokumentasi eksternal ke dalam koleksi di bawah prefiks jalur.
Koleksi situs
pages.json dengan cakupan situs menerapkan nilai bawaan bersama ke seluruh pohon halaman dan mencantumkannya, tanpa mengubah URL atau baris post.
Helper navigasi
blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page(), dan blockstudio_page_content() menyusun sidebar, paginasi, dan isi.
Koleksi dan tipe pos
Koleksi dapat mendaftarkan tipe pos hierarkis khusus.
Penguncian template
Kunci halaman atau blok individual dengan contentOnly, all, atau insert.
Tulis HTML, dapatkan blok
Elemen standar seperti <h1>, <p>, dan <ul> dipetakan ke blok inti. Gunakan <block> untuk nama blok dan tingkat nesting lainnya.
Blockstudio mengurai tata letak halaman lengkap menjadi blok WordPress yang nyata dan dapat diedit.
<div>
<h1 blockEditingMode="contentOnly">About Us</h1>
<p>We build tools for WordPress developers.</p>
<img src="/team.jpg" alt="Our team" />
</div>
<block name="core/columns">
<block name="core/column"><h2>Our Mission</h2></block>
<block name="core/column"><h2>Our Stack</h2></block>
</block>Halaman yang dirender oleh komponen
Atur render di page.json ke entri seperti page.tsx dan loader data.php, lalu renderer halaman yang didaftarkan tema atau plugin Anda akan menggambar seluruh halaman. Sync menyimpan satu blok blockstudio/page, dan konten WordPress seperti shortcode tetap berada di slotnya.
Aset yang dikembalikan renderer menjalani pemrosesan yang sama dengan aset blok dan dicetak sekali, sehingga halaman yang diprerender menyertakannya. blockstudio.dev sendiri dibuat dari halaman komponen.
{
"name": "legal-notice",
"title": "Legal Notice",
"slug": "legal-notice",
"postStatus": "publish",
"render": { "entry": "page.tsx", "data": "data.php" }
}add_action(
'blockstudio/pages/renderers',
static function (): void {
Blockstudio\Page_Renderers::register(
'react',
array(
'extensions' => array( 'tsx' ),
'layouts' => array( 'layout.tsx' ),
'render' => 'my_theme_render_page',
)
);
}
);Rute tanpa post
Blockstudio\Virtual_Routes::register() menyajikan dokumen yang tidak memiliki post, seperti referensi komponen atau katalog. Dengan prefix dan match, satu pendaftaran menangani seluruh keluarga URL, dan mengembalikan null membuat URL tetap WordPress.
Rute dirender di dalam buffer output milik Blockstudio, sehingga bloknya mendapatkan aset dan output Tailwind. Jalur di urls disertakan dalam build prerender statis, dan Virtual_Routes::urls() mengembalikannya untuk sitemap.
add_action( 'init', function () {
Blockstudio\Virtual_Routes::register(
'components',
function ( $component, string $rest ) {
get_header();
echo my_component_page( $component );
get_footer();
},
[
'prefix' => true,
'match' => fn ( string $rest ) => '' === $rest ? 'index' : my_component( $rest ),
'title' => fn ( $component ) => my_component_title( $component ),
'urls' => fn () => my_component_paths(),
]
);
} );Sinkronkan saat Anda menginginkannya
File halaman hanya berubah WordPress jika Anda memintanya. wp bs pages sync menerapkan setiap sumber yang berubah, mempertahankan konten editor yang memiliki kunci, dan menghapus halaman yang filenya sudah tidak ada.
Fingerprint mencakup manifes, loader, tata letak, dan sumber, sehingga halaman yang tidak berubah tidak memerlukan penulisan apa pun. Deploy menjalankan Pages::reconcile() dan mendapatkan laporan yang dapat dibaca mesin.
# Apply changed sources, keep keyed edits
wp bs pages sync
# Replace managed content from the files
wp bs pages sync --authoritative
# Compare every page and report as JSON
wp bs pages sync --full --format=json$report = Blockstudio\Pages::reconcile();
if (0 === $report['failed']) {
// Once the release is live and verified:
Blockstudio\Pages::store_successful_source_identity(
$report['sourceIdentity']
);
}Blok berkunci mempertahankan konten
Tambahkan key ke blok mana pun. Pada sinkronisasi berikutnya, blok berkunci menggabungkan atribut template dengan konten pengguna yang sudah ada, sedangkan blok tanpa kunci akan diganti.
Kembangkan struktur di berbagai deployment sementara konten klien tetap utuh.
<h1 key="title">About Us</h1>
<block name="core/cover" key="hero" url="/hero.jpg">
<h2>Welcome to our company</h2>
<p>Edit this content freely.</p>
</block>
<block name="core/columns" key="team">
<block name="core/column"><h3>Our Team</h3></block>
</block>{
"name": "about",
"title": "About Us",
"slug": "about",
"templateLock": "contentOnly"
}Penguncian template dan mode pengeditan
"all" mencegah perubahan, "contentOnly" mengunci struktur sambil mengizinkan pengeditan teks, dan "insert" mengizinkan pengeditan/pengurutan ulang tanpa menambah atau menghapus.
Ganti elemen apa pun dengan blockEditingMode agar halaman terkunci dapat diedit secara selektif atau untuk menonaktifkan satu blok.
<h1>Welcome to Our Product</h1>
<p>The best solution for your needs.</p>
<block name="core/cover" blockEditingMode="disabled" url="/static-banner.jpg">
<p>Promotional banner</p>
</block>
<block name="core/group" blockEditingMode="default">
<h2>Customizable Section</h2>
</block>{
"name": "landing",
"title": "Landing Page",
"slug": "landing",
"templateLock": "contentOnly",
"blockEditingMode": "contentOnly"
}Template Site Editor dari file
Tambahkan template.json dan template ke templates/, atau part.json ke parts/, agar tema blok Anda mendapatkan sumber wp_template dan wp_template_part berbasis file.
Keduanya menggunakan sintaks yang sama seperti halaman. Kustomisasi Site Editor tetap diutamakan sampai direset, lalu sumber file akan kembali.
<block name="core/template-part" slug="header" />
<div>
<h1>Welcome</h1>
<block name="core/post-content" />
</div>
<block name="core/template-part" slug="footer" />{
"slug": "front-page",
"title": "Front Page",
"description": "Homepage template"
}{
"slug": "header",
"title": "Header",
"area": "header"
}Konten database terpilih di git
Proyek wp bs content pull mengekspor pos, term, relasi, dan metadata yang dideklarasikan serta masuk daftar izin ke file portabel, lalu push menerapkannya ke lingkungan lain. Referensi, induk, dan relasi term yang dideklarasikan ikut dipindahkan sebagai UID stabil.
Post yang dikelola oleh sinkronisasi halaman dapat dipadukan dengan includePageSyncManaged. File-nya menyertakan "bodyOwner": "page-sync", sehingga Content Sync memindahkan metadata sementara sinkronisasi halaman mempertahankan isi.
{
"content": {
"enabled": true,
"id": "default",
"path": "content",
"postTypes": ["team_member"],
"taxonomies": ["category"],
"meta": {
"include": ["_my_*"],
"references": {
"_thumbnail_id": { "kind": "attachment" },
"_related_posts": { "kind": "post", "path": "*" }
}
},
"media": "manifest"
}
}wp bs content pull --dry-run
wp bs content pull
wp bs content status
wp bs content push --dry-run
wp bs content push --prune --yesBlok berkunci
Pertahankan konten pengguna saat template berkembang.
Mode pengeditan
Tetapkan nilai default halaman dan ganti elemen satu per satu.
Block Bindings
Hubungkan blok ke meta pos agar konten tetap tersimpan setelah sinkronisasi.
Template tipe post
templateFor menjadikan halaman sebagai struktur blok awal untuk setiap post baru dari suatu tipe.
ID post yang dipertahankan
postId menggunakan kembali ID yang sama saat halaman dihapus lalu disinkronkan kembali, sehingga menu dan tautan tetap berfungsi.
Kerangka dan penguncian
sync: false dengan Pages::force_sync() membuat halaman sekali agar dikelola editor. Pages::lock() dan unlock() mengecualikan satu halaman dari sinkronisasi.
Renderer parser kustom
Filter builder dan renderer mengubah tag blok menjadi array blok dari blok pihak ketiga, atau mengubah cara blok inti ditulis.
Pemetaan elemen
Petakan elemen HTML ke blok lain, pilih blok berdasarkan atribut elemen, dan arahkan HTML paragraf ke kolom konten.
Jalur penemuan kustom
Filter menambahkan root untuk halaman, pola, dan template Site Editor, misalnya dari plugin.
Sumber penemuan logis
Pratinjau, overlay, dan tema yang dihasilkan dapat memberikan inventaris file gabungan kepada Blockstudio, bukan hanya satu folder tema.
Referensi stabil
Referensi post, term, dan lampiran yang dideklarasikan menjadi UID portabel saat pull dan diubah menjadi ID lokal saat push.
Status sebelum push
wp bs content status melaporkan setiap entitas sebagai tidak berubah, akan diperbarui, tidak ada di database, konflik, terkunci, atau yatim, serta memperingatkan tentang kunci meta yang tampak seperti rahasia.
Push tervalidasi dan terbatas cakupannya
Push memvalidasi seluruh rencana sebelum menulis dan melewati entitas yang terkunci. –dry-run menampilkan rencana, sedangkan –prune –yes hanya menghapus entitas dari set konten ini.
Terkelola dalam kontrol versi
Lacak file halaman di Git dan deploy ke berbagai lingkungan.
PHP API
Akses pohon, anak, metadata, sinkronisasi, penguncian, dan ID secara terprogram.
Kit ekstensi resmi
Template situs premium, instruksi sistem AI, dan komunitas Discord privat. Pembelian satu kali, pembaruan seumur hidup.
- 500+ templat situs
- Instruksi sistem AI
- Pembaruan seumur hidup
- Komunitas privat Discord