Täielikud lehed koodis määratuna
Mallid ja Markdown sünkroonitakse ühe käsuga keskkonda WordPress.
Failidest loodud kogud
Määrake pages.json ja laske Blockstudio-l kõik selle alamkataloogide allikad avastada. Pesastatud teedest saavad pesastatud lehed, vaikeseaded kehtivad kogule ning puuduvad ülemlehed saab luua.
Kasutage kogusid dokumentatsiooni, teadmistebaaside või sihtlehtede jaoks ning ühendage välised kaustad teeprefiksi alla käsuga loader.php.
Lisage pages.json kõrvale layout.php või renderdaja paigutus, näiteks layout.tsx, et mähkida kogu kogu iga leht ühte kesta, kus külgriba jaoks on blockstudio_page_tree().
{
"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>Selgesõnaline sünkroonimine
wp bs pages sync rakendab muudatused; muutmata lehtede kirjutamine ei maksa midagi.
Markdown allikad
Kasutage index.md-i koos päiseandmetega või ühendage page.json sisuga Markdown.
Toores Markdown
Markdown faililehed vastavad nende URL aadressil, millele lisatakse .md, või tavalisel URL aadressil päise Accept: text/markdown korral; kaasas on kanooniline link tagasi HTML juurde.
Kogulaadurid
Ühendage välise dokumentatsiooni kaustad kogusse teeprefiksi alla.
Saidi kogud
pages.json, mille ulatus on site, rakendab ühiseid vaikeväärtusi tervele lehtede puule ja loetleb selle, muutmata URL-e ega postitusridu.
Navigeerimisabilised
blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() ja blockstudio_page_content() loovad külgribasid, leheküljevahetajaid ja sisuosa.
Kogud ja postitustüübid
Kogud saavad registreerida spetsiaalsed hierarhilised postitustüübid.
Mallide lukustamine
Lukustage lehed või üksikud plokid väärtustega contentOnly, all või insert.
Kirjuta HTML, saad plokid
Standardelemendid, näiteks <h1>, <p> ja <ul>, vastendatakse tuumplokkidega. Kasutage <block> kõigi muude plokinimede ja pesastustasemete jaoks.
Blockstudio parsib täielikud lehepaigutused päris redigeeritavateks WordPress plokkideks.
<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>Komponentide renderdatud lehed
Määrake render väärtuseks page.json-is kirje, näiteks page.tsx, ja data.php laadija; seejärel renderdab teie teema või plugina registreeritud leherenderdaja kogu lehe. Sünkroonimine salvestab ühe blockstudio/page ploki ning WordPress sisu, näiteks lühikood, jääb oma pesasse.
Renderdaja tagastatud varasid töödeldakse samamoodi nagu ploki varasid ja prinditakse üks kord, nii et eelt renderdatud leht sisaldab neid. blockstudio.dev ise luuakse komponentlehtedest.
{
"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',
)
);
}
);Postituseta marsruudid
Blockstudio\Virtual_Routes::register() serveerib dokumenti, mille taga pole postitust, näiteks komponendi viidet või kataloogi. prefix ja match abil vastab üks registreering tervele URL-ide perele ning tagastades null, jätate URL WordPress hooleks.
Marsruut renderdatakse Blockstudio väljundpuhvris, nii et selle plokid saavad oma varad ja Tailwind väljundi. urls teed lisatakse staatiliste eelt renderdamise järkude hulka ning Virtual_Routes::urls() tagastab need saidikaardi jaoks.
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(),
]
);
} );Sünkroonige siis, kui ise soovite
Lehefaile muudetakse WordPress-is ainult teie soovil. wp bs pages sync rakendab kõik muudetud allikad, säilitab võtmega redaktori sisu ning eemaldab lehed, mille failid on kadunud.
Sõrmejäljed hõlmavad manifeste, laadureid, paigutusi ja allikaid, nii et muutmata lehtede kirjutamine ei maksa midagi. Juurutused käivitavad käsu Pages::reconcile() ja saavad masinloetava aruande.
# 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']
);
}Võtmega plokid säilitavad sisu
Lisage key mis tahes plokile. Järgmisel sünkroonimisel ühendavad võtmega plokid malli atribuudid olemasoleva kasutaja sisuga, võtmeta plokid aga asendatakse.
Muutke struktuuri juurutuste käigus, säilitades samal ajal kliendi sisu.
<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"
}Mallide lukustamine ja redigeerimisrežiimid
"all" takistab muudatusi, "contentOnly" lukustab struktuuri, lubades samal ajal teksti muuta, ning "insert" lubab muuta järjekorda ja sisu, kuid ei luba elemente lisada ega eemaldada.
Kirjutage mis tahes elemendi säte käsuga blockEditingMode üle, et muuta lukustatud leht valikuliselt redigeeritavaks või üksik plokk keelata.
<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 Editori mallid failidest
Lisage templates/-i fail template.json ja mall või lisage parts/-i part.json; nii saab teie plokiteema failipõhised allikad wp_template ja wp_template_part jaoks.
Need kasutavad lehtedega sama süntaksit. Site Editoris tehtud kohandus jääb kehtima, kuni keegi selle lähtestab; seejärel taastub failiallikas.
<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"
}Valitud andmebaasisisu asukohas git
wp bs content pull ekspordib lubatud postitused, terminid, seosed ja deklareeritud metaandmed kaasaskantavatesse failidesse ning push rakendab need teises keskkonnas. Deklareeritud viited, vanemad ja terminiseosed liiguvad püsivate UID-dena.
Lehe sünkroonimisega hallatavad postitused saavad liituda includePageSyncManaged-iga. Nende failid sisaldavad "bodyOwner": "page-sync", nii et Content Sync teisaldab metaandmed, samal ajal kui lehe sünkroonimine hoiab sisu alles.
{
"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 --yesVõtmega plokid
Säilitage kasutaja sisu mallide arenedes.
Redigeerimisrežiimid
Määrake lehe vaikeväärtused ja kirjutage üksikute elementide sätted üle.
Plokisidumised
Ühendage plokid postituse metaandmetega, et sisu säiliks sünkroonimisel.
Postitustüübi mallid
templateFor määrab lehe iga uut tüüpi postituse algseks plokistruktuuriks.
Kinnitatud postituste ID-d
postId taastab sama ID, kui leht kustutatakse ja uuesti sünkroonitakse, nii et menüüd ja lingid töötavad edasi.
Põhjad ja lukud
sync: false koos Pages::force_sync()-ga loob lehe üks kord, et toimetajad saaksid seda ise hallata. Pages::lock() ja unlock() jätavad ühe lehe sünkroonimisest välja.
Kohandatud parseri renderdajad
Ehitaja ja renderdaja filtrid muudavad plokisildi kolmanda osapoole ploki plokimassiiviks või muudavad tuumploki kirjutamisviisi.
Elementide vastendamine
Vastendage HTML element teise plokiga, valige plokk elemendi atribuutide põhjal ja suunake lõigu HTML sisuväljale.
Kohandatud avastusteed
Filtrid lisavad lehtede, mustrite ja saidiredaktori mallide juurkaustu, näiteks plugina kaudu.
Loogilised avastusallikad
Eelvaated, ülekatted ja loodud teemad saavad anda Blockstudio-le koostatud failide loendi ühe teemakausta asemel.
Stabiilsed viited
Deklareeritud postituste, terminite ja manuste viited muutuvad sissetoomisel kaasaskantavateks UID-deks ning lahendatakse saatmisel kohalikeks ID-deks.
Olek enne saatmist
wp bs content status raporteerib iga üksuse olekuna unchanged, would-update, missing-db, conflict, locked või orphaned ning hoiatab saladustena näivate metavõtmete eest.
Valideeritud ja piiritletud saatmised
Push valideerib kogu plaani enne kirjutamist ja jätab lukustatud üksused vahele. –dry-run kuvab plaani ning –prune –yes eemaldab ainult selle sisukomplekti üksused.
Versioonihallatavad
Jälgige lehefaile keskkonnas Git ja juurutage need eri keskkondadesse.
PHP API
Juurdepääs puudele, alamüksustele, metaandmetele, sünkroonimisele, lukustamisele ja ID-dele programmiliselt.
Ametlik laienduskomplekt
Esmaklassilised saidimallid, tehisintellekti süsteemijuhised ja privaatne Discord kogukond. Ühekordne ost, eluaegsed uuendused.
- 500+ saidimalli
- Tehisintellekti süsteemijuhised
- Eluaegsed uuendused
- Privaatne Discord-i kogukond