Teljes oldalak, kódban meghatározva
Sablonok és Markdown, egyetlen paranccsal szinkronizálva a következővel: WordPress.
Fájlokból létrehozott gyűjtemények
Határozd meg a pages.json elemet, és hagyd, hogy a Blockstudio felderítse az összes alatta lévő forrást. A beágyazott útvonalakból beágyazott oldalak lesznek, az alapértelmezések a gyűjteményre vonatkoznak, a hiányzó szülőoldalak pedig létrehozhatók.
Használj gyűjteményeket dokumentációhoz, tudásbázisokhoz vagy céloldalakhoz; külső mappákat pedig a loader.php segítségével csatolj egy útvonallelőtag alá.
Helyezzen egy layout.php fájlt vagy egy renderelőelrendezést, például a layout.tsx fájlt a pages.json mellé, hogy a gyűjtemény minden oldalát egyetlen keretbe foglalja, a blockstudio_page_tree() fájllal az oldalsávhoz.
{
"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>Kifejezett szinkronizálás
A wp bs pages sync alkalmazza a módosításokat; a változatlan oldalak egyetlen írást sem igényelnek.
Markdown-források
Használd a index.md elemet frontmatterrel, vagy párosítsd a page.json elemet a Markdown tartalommal.
Nyers Markdown
A Markdown fájloldalak a saját URL útvonalukon, valamint .md kiterjesztéssel, illetve a szokásos URL címen érhetők el Accept: text/markdown esetén, a HTML oldalra visszamutató kanonikus hivatkozással.
Gyűjteménybetöltők
Csatolj külső dokumentációs mappákat egy gyűjteményhez, útvonallelőtag alatt.
Webhelygyűjtemények
A site hatókörű pages.json közös alapértelmezett beállításokat alkalmaz a teljes oldalfára, és listázza azt az URL-ek vagy a bejegyzéssorok módosítása nélkül.
Navigációs segédfüggvények
A blockstudio_page_tree(), a blockstudio_page_children(), a blockstudio_current_page() és a blockstudio_page_content() oldalsávokat, lapozókat és törzstartalmat állít össze.
Gyűjtemények és bejegyzéstípusok
A gyűjtemények saját, hierarchikus bejegyzéstípusokat regisztrálhatnak.
Sablonok zárolása
Zárolj oldalakat vagy egyes blokkokat a contentOnly, all vagy insert értékkel.
Írja meg a HTML-t, kapjon blokkokat
Az olyan szabványos elemek, mint a <h1>, a <p> és a <ul>, alapblokkokhoz kapcsolódnak. Minden más blokknévhez és beágyazási szinthez használd a <block> elemet.
A Blockstudio teljes oldalelrendezéseket dolgoz fel valódi, szerkeszthető WordPress blokkokká.
<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>Komponensek által renderelt oldalak
Állítsa be a render értékét a page.json fájlban egy olyan bejegyzésre, mint a page.tsx, és egy data.php betöltőre; ekkor a témája vagy bővítménye által regisztrált oldalrenderelő jeleníti meg a teljes oldalt. A Sync egyetlen blockstudio/page blokkot tárol, a WordPress tartalom, például egy shortcode pedig a saját helyén marad.
A renderelő által visszaadott eszközök ugyanazt a feldolgozást kapják, mint a blokk eszközei, és csak egyszer kerülnek kiírásra, így az előre renderelt oldal is tartalmazza őket. Maga a blockstudio.dev komponensoldalakból épül fel.
{
"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',
)
);
}
);Bejegyzés nélküli útvonalak
A Blockstudio\Virtual_Routes::register() olyan dokumentumot szolgál ki, amelyhez nem tartozik bejegyzés, például egy komponensreferenciát vagy katalógust. A prefix és a match használatával egyetlen regisztráció URL-ek egész családját kezeli, a null visszaadásával pedig a URL feladatát a WordPress végzi.
Az útvonal a Blockstudio kimeneti pufferében renderelődik, így a blokkjai megkapják az eszközeiket és a Tailwind kimenetet. A urls útvonalai bekerülnek a statikus prerenderelési buildelésbe, a Virtual_Routes::urls() pedig visszaadja őket egy webhelytérképhez.
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(),
]
);
} );Szinkronizálás csak kérésre
Az oldalfájlok csak akkor módosulnak a WordPress rendszerben, amikor kéred. A wp bs pages sync alkalmazza az összes módosított forrást, megőrzi a kulccsal ellátott szerkesztői tartalmat, és törli a már nem létező fájlokhoz tartozó oldalakat.
Az ujjlenyomatok a jegyzékeket, a betöltőket, az elrendezéseket és a forrásokat is lefedik, ezért a változatlan oldalak egyetlen írást sem igényelnek. A telepítések meghívják a Pages::reconcile() elemet, és géppel olvasható jelentést kapnak.
# 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']
);
}A kulccsal ellátott blokkok megőrzik a tartalmat
Adj hozzá egy key elemet bármely blokkhoz. A következő szinkronizáláskor a kulccsal ellátott blokkok egyesítik a sablon attribútumait a meglévő felhasználói tartalommal, a kulcs nélkülieket pedig lecserélik.
A struktúra a telepítések során változhat, miközben az ügyfél tartalma megmarad.
<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"
}Sablonzárolás és szerkesztési módok
A "all" megakadályozza a módosításokat, a "contentOnly" zárolja a struktúrát, de engedi a szöveg szerkesztését, a "insert" pedig lehetővé teszi a szerkesztést és az átrendezést, hozzáadás és törlés nélkül.
Írd felül bármely elem beállítását a blockEditingMode segítségével, hogy a zárolt oldal egyes részei szerkeszthetők legyenek, vagy letilts egy adott blokkot.
<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-sablonok fájlokból
Adj hozzá egy template.json elemet és egy sablont ehhez: templates/, vagy használd a part.json elemet a parts/ számára; így a blokkos témád fájlokból származó wp_template és wp_template_part forrásokat kap.
Ugyanazt a szintaxist használják, mint az oldalak. A Site Editorban végzett testreszabás addig elsőbbséget élvez, amíg vissza nem állítják; ezután ismét a fájlforrás lép érvénybe.
<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"
}Kiválasztott adatbázistartalom a git helyen
A wp bs content pull engedélyezőlistán szereplő bejegyzéseket, kifejezéseket, kapcsolatokat és deklarált metaadatokat exportál hordozható fájlokba, a push pedig alkalmazza ezeket egy másik környezetben. A deklarált hivatkozások, szülők és kifejezéskapcsolatok stabil UID-ként maradnak meg.
Az oldalszinkronizálással kezelt bejegyzések a includePageSyncManaged elemmel is használhatók. A fájljaik "bodyOwner": "page-sync" értéket tartalmaznak, így a Content Sync mozgatja a metaadatokat, az oldalszinkronizálás pedig megtartja a törzset.
{
"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 --yesKulccsal ellátott blokkok
Őrizd meg a felhasználói tartalmat a sablonok fejlesztésekor.
Szerkesztési módok
Állítsd be az alapértelmezéseket az oldalakhoz, majd írd felül az egyes elemeket.
Blokk-kötések
Kapcsold a blokkokat a bejegyzésmeta adataihoz, hogy a tartalom a szinkronizálás után is megmaradjon.
Bejegyzéstípus-sablonok
A templateFor egy oldalt tesz meg az adott típus minden új bejegyzésének kiinduló blokkstruktúrájává.
Rögzített bejegyzésazonosítók
A postId visszaállítja ugyanazt az azonosítót, amikor egy oldalt törölnek, majd újra szinkronizálnak, így a menük és a hivatkozások továbbra is működnek.
Kezdősablonok és zárolások
A sync: false a Pages::force_sync() beállítással egyszer hoz létre egy oldalt, amelyet a szerkesztők kezelhetnek. A Pages::lock() és a unlock() egy-egy oldalt kizár a szinkronizálásból.
Egyéni parserrenderelők
A builder- és renderelőszűrők egy blokkcímkét harmadik féltől származó blokk tömbjévé alakítanak, vagy módosítják, hogyan íródik ki egy alapblokk.
Elemek hozzárendelése
Rendeljen egy HTML elemet egy másik blokkhoz, válassza ki a blokkot az elem attribútumai alapján, és irányítsa a bekezdés HTML értékét egy tartalommezőbe.
Egyéni felderítési útvonalak
A szűrők további gyökérkönyvtárakat adnak hozzá az oldalakhoz, mintákhoz és a Site Editor sablonjaihoz, például egy bővítményből.
Logikai felderítési források
Az előnézetek, az átfedések és a generált témák egyetlen témamappa helyett összeállított fájllistát adhatnak át a Blockstudio számára.
Stabil hivatkozások
A deklarált bejegyzés-, kifejezés- és csatolmányhivatkozások beolvasáskor hordozható UID-kké válnak, feltöltéskor pedig helyi azonosítókra oldódnak fel.
Állapot a feltöltés előtt
A wp bs content status minden entitás állapotát változatlan, frissülne, hiányzik az adatbázisból, ütközik, zárolt vagy árva értékként jelzi, és figyelmeztet a titoknak tűnő meta kulcsokra.
Ellenőrzött, hatókörhöz kötött feltöltések
A feltöltés írás előtt ellenőrzi a teljes tervet, és kihagyja a zárolt entitásokat. A –dry-run megjeleníti a tervet, a –prune –yes pedig csak az adott tartalomkészlet entitásait távolítja el.
Verziókezelve
Kövesd az oldalfájlokat a Git rendszerben, és telepítsd őket a különböző környezetekbe.
PHP API
Programozottan hozzáférhetsz a fákhoz, a gyermekelemekhez, a metaadatokhoz, a szinkronizáláshoz, a zároláshoz és az azonosítókhoz.
A hivatalos bővítőkészlet
Prémium webhelysablonok, MI-rendszerutasítások és privát Discord közösség. Egyszeri vásárlás, élethosszig tartó frissítések.
- 500+ webhelysablon
- AI-rendszerutasítások
- Élettartamra szóló frissítések
- Privát Discord közösség