Kompletta sidor, definierade i kod
Mallar och Markdown, synkroniserade till WordPress med ett enda kommando.
Samlingar från filer
Definiera pages.json och låt Blockstudio hitta varje källa under den. Nästlade sökvägar blir nästlade sidor, standardvärden gäller för samlingen och saknade överordnade sidor kan skapas.
Använd samlingar för dokumentation, kunskapsbaser eller landningssidor, och montera externa mappar under ett sökvägsprefix med loader.php.
Lägg en layout.php, eller en renderingslayout som layout.tsx, bredvid pages.json för att omsluta varje sida i samlingen i ett gemensamt skal, med blockstudio_page_tree() för sidofältet.
{
"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>Explicit synkronisering
wp bs pages sync tillämpar ändringar; oförändrade sidor kräver inga skrivningar.
Markdown-källor
Använd index.md med frontmatter eller kombinera page.json med Markdown-innehåll.
Rå Markdown
Markdown-filsidor kan nås via sin URL följt av .md, eller via den vanliga URL vid Accept: text/markdown, med en kanonisk länk tillbaka till HTML.
Samlingsinläsare
Montera externa dokumentationsmappar i en samling under ett sökvägsprefix.
Webbplatssamlingar
En pages.json med omfattningen site tillämpar gemensamma standardvärden för ett helt sidträd och listar det, utan att ändra URL:er eller inläggsrader.
Navigeringshjälpare
blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() och blockstudio_page_content() bygger sidofält, sidbläddrare och brödtext.
Samlingar och inläggstyper
Samlingar kan registrera särskilda hierarkiska inläggstyper.
Mallåsning
Lås sidor eller enskilda block med contentOnly, all eller insert.
Skriv HTML, få block
Standardelement som <h1>, <p> och <ul> motsvarar kärnblock. Använd <block> för alla andra blocknamn och nästlingsnivåer.
Blockstudio tolkar kompletta sidlayouter till riktiga, redigerbara WordPress-block.
<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>Sidor som renderas av komponenter
Ange render i page.json som en post, till exempel page.tsx, och en data.php-laddare, så renderar sidrenderaren som ditt tema eller tillägg registrerar hela sidan. Synkronisering lagrar ett blockstudio/page-block, och innehåll från WordPress, till exempel en kortkod, ligger kvar på sin plats.
Resurser som renderaren returnerar bearbetas på samma sätt som blockresurser och skrivs ut en gång, så en förhandsrenderad sida innehåller dem. Själva blockstudio.dev byggs av komponentsidor.
{
"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',
)
);
}
);Rutter utan inlägg
Blockstudio\Virtual_Routes::register() levererar ett dokument som inte har något inlägg bakom sig, till exempel en komponentreferens eller en katalog. Med prefix och match kan en registrering hantera en hel familj av URL:er, och om du returnerar null överlåts URL till WordPress.
Rutten renderas i Blockstudios utbuffert, så dess block får sina resurser och Tailwind-utdata. Sökvägar i urls ingår i statiska förhandsrenderingar, och Virtual_Routes::urls() returnerar dem för en webbplatskarta.
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(),
]
);
} );Synkronisera när du själv vill
Sidfiler ändras endast i WordPress när du ber om det. wp bs pages sync tillämpar varje ändrad källa, bevarar redigerarinnehåll med nycklar och tar bort sidor vars filer saknas.
Fingeravtryck omfattar manifest, inläsare, layouter och källor, så oförändrade sidor kräver inga skrivningar. Driftsättningar anropar Pages::reconcile() och får en maskinläsbar rapport.
# 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']
);
}Block med nycklar bevarar innehåll
Lägg till key i valfritt block. Vid nästa synkronisering slås mallattribut samman med befintligt användarinnehåll i block med nycklar, medan block utan nycklar ersätts.
Utveckla strukturen mellan driftsättningar medan kundernas innehåll förblir intakt.
<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"
}Mallås och redigeringslägen
"all" förhindrar ändringar, "contentOnly" låser strukturen men tillåter textredigering, och "insert" tillåter redigering och omordning utan att lägga till eller ta bort.
Åsidosätt valfritt element med blockEditingMode för att göra en låst sida redigerbar på utvalda ställen eller inaktivera ett enskilt block.
<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"
}Site Editor-mallar från filer
Lägg till template.json och en mall i templates/, eller part.json i parts/, så får ditt blocktema wp_template– och wp_template_part-källor från filer.
De använder samma syntax som sidor. En anpassning i Site Editor har fortfarande företräde tills någon återställer den, och då återgår filkällan.
<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"
}Valt databasinnehåll i git
wp bs content pull exporterar tillåtna inlägg, termer, relationer och deklarerade metadata till portabla filer, och push tillämpar dem i en annan miljö. Deklarerade referenser, föräldrar och termrelationer överförs som stabila UID:er.
Inlägg som hanteras av sidsynkronisering kan kombineras med includePageSyncManaged. Deras filer innehåller "bodyOwner": "page-sync", så Content Sync flyttar metadata medan sidsynkroniseringen behåller brödtexten.
{
"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 --yesNycklade block
Bevara användarinnehåll när mallar utvecklas.
Redigeringslägen
Ange sidans standardvärden och åsidosätt enskilda element.
Blockbindningar
Anslut block till inläggsmetadata så att innehållet överlever synkronisering.
Mallar för inläggstyper
templateFor gör en sida till startstrukturen för block i varje nytt inlägg av en viss typ.
Fästa inläggs-ID:n
postId återanvänder samma ID när en sida raderas och synkroniseras igen, så menyer och länkar fortsätter att fungera.
Skal och lås
sync: false tillsammans med Pages::force_sync() skapar en sida en gång som redigerarna får förvalta. Pages::lock() och unlock() undantar en sida från synkronisering.
Anpassade renderare för parsers
Builder- och rendererfilter omvandlar en blocktagg till blockarrayen för ett block från tredje part eller ändrar hur ett kärnblock skrivs.
Elementmappning
Mappa ett HTML-element till ett annat block, välj block utifrån elementets attribut och dirigera styckets HTML till ett innehållsfält.
Anpassade sökvägar för upptäckt
Filter lägger till rötter för sidor, mönster och mallar i Site Editor, till exempel från ett tillägg.
Logiska upptäcktskällor
Förhandsvisningar, överlägg och genererade teman kan ge Blockstudio en sammansatt fillista i stället för en enda temamapp.
Stabila referenser
Deklarerade referenser till inlägg, termer och bilagor blir portabla UID:er vid hämtning och löses upp till lokala ID:n vid push.
Status före push
wp bs content status rapporterar varje enhet som oförändrad, skulle uppdateras, saknas i databasen, konflikt, låst eller föräldralös, och varnar för metanycklar som kan vara hemligheter.
Validerade pushar med begränsad omfattning
Push validerar hela planen innan den skriver och hoppar över låsta enheter. –dry-run visar planen, och –prune –yes tar bara bort enheterna i den här innehållsuppsättningen.
Versionshanterat
Spåra sidfiler i Git och driftsätt dem i olika miljöer.
PHP API
Kom åt träd, underordnade objekt, metadata, synkronisering, låsning och ID:n programmatiskt.
Det officiella tilläggspaketet
Premiumwebbplatsmallar, systeminstruktioner för AI och en privat Discord-community. Engångsköp, uppdateringar på livstid.
- 500+ webbplatsmallar
- AI-systeminstruktioner
- Uppdateringar livet ut
- Privat Discord-community