Vollständige Seiten, im Code definiert
Templates und Markdown, mit einem Befehl mit WordPress synchronisiert.
Sammlungen aus Dateien
Definiere pages.json und lass Blockstudio alle darin enthaltenen Quellen erkennen. Verschachtelte Pfade werden zu verschachtelten Seiten, Standardwerte gelten für die Sammlung und fehlende übergeordnete Seiten können erstellt werden.
Verwende Sammlungen für Dokumentationen, Wissensdatenbanken oder Landingpages und binde externe Ordner mit loader.php unter einem Pfadpräfix ein.
Lege ein layout.php oder ein Renderer-Layout wie layout.tsx neben pages.json, um jede Seite der Sammlung in eine gemeinsame Hülle einzubetten, mit blockstudio_page_tree() für die Seitenleiste.
{
"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>Synchronisierung auf Abruf
wp bs pages sync wendet Änderungen an; unveränderte Seiten verursachen keine Schreibvorgänge.
Markdown-Quellen
Verwende index.md mit Frontmatter oder kombiniere page.json mit Markdown-Inhalten.
Rohes Markdown
Markdown-Dateiseiten werden unter ihrem URL plus .md oder bei Accept: text/markdown unter dem normalen URL bereitgestellt, mit einem kanonischen Link zurück zum HTML.
Collection-Loader
Binde externe Doku-Ordner unter einem Pfadpräfix in eine Sammlung ein.
Website-Sammlungen
Ein pages.json mit dem Geltungsbereich „site“ wendet gemeinsame Standardwerte auf einen ganzen Seitenbaum an und listet ihn auf, ohne URLs oder Beitragszeilen zu ändern.
Navigationshelfer
blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() und blockstudio_page_content() erstellen Seitenleisten, Seitennavigation und den Inhalt.
Sammlungen und Inhaltstypen
Sammlungen können eigene hierarchische Inhaltstypen registrieren.
Vorlagen sperren
Sperre Seiten oder einzelne Blöcke mit contentOnly, all oder insert.
HTML schreiben, Blöcke erhalten
Standardelemente wie <h1>, <p> und <ul> werden Kernblöcken zugeordnet. Verwende <block> für alle anderen Blocknamen und Verschachtelungsebenen.
Blockstudio analysiert vollständige Seitenlayouts und wandelt sie in echte, bearbeitbare WordPress-Blöcke um.
<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>Von Komponenten gerenderte Seiten
Setze render in page.json auf einen Eintrag wie page.tsx und einen data.php-Loader. Der von deinem Theme oder Plugin registrierte Seiten-Renderer zeichnet dann die ganze Seite. Sync speichert einen blockstudio/page-Block, und WordPress-Inhalte wie ein Shortcode bleiben in ihrem Slot.
Vom Renderer zurückgegebene Assets werden genauso verarbeitet wie Block-Assets und nur einmal ausgegeben, sodass eine vorgerenderte Seite sie enthält. blockstudio.dev selbst wird aus Komponentenseiten erstellt.
{
"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',
)
);
}
);Routen ohne Beitrag
Blockstudio\Virtual_Routes::register() stellt ein Dokument bereit, dem kein Beitrag zugrunde liegt, etwa eine Komponentenreferenz oder ein Katalog. Mit prefix und match beantwortet eine Registrierung eine ganze Gruppe von URLs, und die Rückgabe von null überlässt URL WordPress.
Die Route wird im Ausgabepuffer von Blockstudio gerendert, sodass ihre Blöcke ihre Assets und Tailwind-Ausgabe erhalten. Pfade in urls fließen in statische Prerender-Builds ein, und Virtual_Routes::urls() gibt sie für eine Sitemap zurück.
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(),
]
);
} );Synchronisiere nur auf deinen Befehl
Seitendateien ändern WordPress nur, wenn du es anforderst. wp bs pages sync übernimmt alle geänderten Quellen, erhält mit Schlüsseln versehene Editor-Inhalte und entfernt Seiten, deren Dateien nicht mehr vorhanden sind.
Fingerabdrücke berücksichtigen Manifeste, Loader, Layouts und Quellen, sodass unveränderte Seiten keine Schreibvorgänge verursachen. Deployments rufen Pages::reconcile() auf und erhalten einen maschinenlesbaren Bericht.
# 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']
);
}Blöcke mit Schlüssel behalten Inhalte bei
Füge key zu einem beliebigen Block hinzu. Bei der nächsten Synchronisierung werden bei Blöcken mit Schlüssel Template-Attribute mit bestehenden Nutzerinhalten zusammengeführt; Blöcke ohne Schlüssel werden ersetzt.
Entwickle die Struktur über Deployments hinweg weiter, während Kundeninhalte erhalten bleiben.
<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"
}Templatesperre und Bearbeitungsmodi
"all" verhindert Änderungen, "contentOnly" sperrt die Struktur, lässt aber Textbearbeitung zu, und "insert" erlaubt Bearbeiten und Neuanordnen, ohne Elemente hinzuzufügen oder zu entfernen.
Überschreibe beliebige Elemente mit blockEditingMode, damit eine gesperrte Seite gezielt bearbeitet werden kann oder ein einzelner Block deaktiviert wird.
<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-Templates aus Dateien
Füge template.json und ein Template zu templates/ hinzu oder part.json zu parts/, damit dein Block-Theme dateibasierte Quellen für wp_template und wp_template_part erhält.
Sie verwenden dieselbe Syntax wie Seiten. Eine Anpassung im Site-Editor hat weiterhin Vorrang, bis sie zurückgesetzt wird; danach gilt wieder die Datei als Quelle.
<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"
}Ausgewählte Datenbankinhalte in git
wp bs content pull exportiert freigegebene Beiträge, Begriffe, Beziehungen und deklarierte Metadaten in portable Dateien, und push überträgt sie auf eine andere Umgebung. Deklarierte Referenzen, übergeordnete Elemente und Begriffsbeziehungen werden als stabile UIDs übernommen.
Von Page Sync verwaltete Beiträge lassen sich mit includePageSyncManaged kombinieren. Ihre Dateien enthalten "bodyOwner": "page-sync", sodass Content Sync die Metadaten überträgt, während Page Sync den Inhalt beibehält.
{
"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 --yesBlöcke mit Schlüssel
Erhalte Nutzerinhalte, während Templates weiterentwickelt werden.
Bearbeitungsmodi
Lege Standardwerte für Seiten fest und überschreibe einzelne Elemente.
Block Bindings
Verbinde Blöcke mit Beitragsmetadaten, damit Inhalte bei der Synchronisierung erhalten bleiben.
Vorlagen für Beitragstypen
templateFor legt die anfängliche Blockstruktur für jeden neuen Beitrag eines Typs fest.
Fixierte Beitrags-IDs
postId verwendet dieselbe ID erneut, wenn eine Seite gelöscht und erneut synchronisiert wird, sodass Menüs und Links weiterhin funktionieren.
Vorlagen und Sperren
sync: false mit Pages::force_sync() erstellt einmalig eine Seite, die Redakteure selbst verwalten. Pages::lock() und unlock() nehmen je eine Seite von der Synchronisierung aus.
Benutzerdefinierte Parser-Renderer
Builder- und Renderer-Filter wandeln einen Block-Tag in das Block-Array eines Drittanbieter-Blocks um oder ändern, wie ein Core-Block geschrieben wird.
Elementzuordnung
Ordne ein HTML-Element einem anderen Block zu, wähle den Block anhand der Attribute des Elements aus und leite Absatz-HTML in ein Inhaltsfeld.
Benutzerdefinierte Erkennungspfade
Filter fügen Stammverzeichnisse für Seiten, Patterns und Vorlagen des Site Editors hinzu, zum Beispiel aus einem Plugin.
Logische Erkennungsquellen
Vorschauen, Overlays und generierte Themes können Blockstudio statt eines einzelnen Theme-Ordners ein zusammengestelltes Dateiverzeichnis übergeben.
Stabile Referenzen
Deklarierte Referenzen auf Beiträge, Begriffe und Anhänge werden beim Abruf zu portablen UIDs und beim Übertragen in lokale IDs aufgelöst.
Status vor dem Übertragen
wp bs content status meldet jede Entität als unverändert, würde aktualisiert, in der Datenbank fehlend, Konflikt, gesperrt oder verwaist und warnt vor Meta-Keys, die wie Geheimnisse aussehen.
Validierte, eingeschränkte Übertragungen
Push validiert den gesamten Plan vor dem Schreiben und überspringt gesperrte Entitäten. –dry-run zeigt den Plan, und –prune –yes entfernt nur die Entitäten dieses Content-Sets.
Versionsverwaltet
Verfolge Seitendateien in Git und deploye sie in verschiedenen Umgebungen.
PHP API
Greife programmgesteuert auf Bäume, untergeordnete Elemente, Metadaten, Synchronisierung, Sperren und IDs zu.
Das offizielle Erweiterungspaket
Premium-Websitevorlagen, KI-Systemanweisungen und eine private Discord-Community. Einmaliger Kauf, Updates auf Lebenszeit.
- 500+ Website-Vorlagen
- KI-Systemanweisungen
- Updates auf Lebenszeit
- Private Discord-Community