Visi puslapiai apibrėžti kode
Šablonai ir Markdown, vienu įsakymu sinchronizuojami su WordPress.
Iš failų sudaromi rinkiniai
Apibrėžkite pages.json ir leiskite Blockstudio aptikti visus žemiau esančius šaltinius. Įdėtieji keliai tampa įdėtaisiais puslapiais, numatytieji nustatymai taikomi visam rinkiniui, o trūkstamus pirminius puslapius galima sugeneruoti.
Naudokite rinkinius dokumentacijai, žinių bazėms ar nukreipimo puslapiams, o išorinius aplankus prijunkite prie kelio prefikso naudodami loader.php.
Šalia pages.json įdėkite layout.php arba atvaizduoklio išdėstymą, pvz., layout.tsx, kad kiekvienas kolekcijos puslapis būtų apgaubtas vienu apvalkalu, o šoninei juostai būtų naudojamas 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>Aiškus sinchronizavimas
wp bs pages sync pritaiko pakeitimus; nepakitusiems puslapiams nereikia jokių įrašymo operacijų.
Markdown šaltiniai
Naudokite index.md su priekine medžiaga arba susiekite page.json su Markdown turiniu.
Neapdorotas Markdown
Markdown failų puslapiai pasiekiami jų URL su pridėtu .md arba įprastu URL, kai Accept: text/markdown, su kanonine nuoroda atgal į HTML.
Rinkinių įkėlikliai
Prijunkite išorinius dokumentacijos aplankus prie rinkinio nurodydami kelio prefiksą.
Svetainės kolekcijos
pages.json, kurio apimtis yra site, nustato bendrus numatytuosius parametrus visam puslapių medžiui ir jį pateikia sąraše, nekeisdamas URL ar įrašų eilučių.
Navigacijos pagalbinės funkcijos
blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() ir blockstudio_page_content() sukuria šonines juostas, puslapiavimo valdiklius ir pagrindinį turinį.
Rinkiniai ir įrašų tipai
Rinkiniai gali užregistruoti atskirus hierarchinius įrašų tipus.
Šablono užrakinimas
Užrakinkite puslapius ar atskirus blokus naudodami contentOnly, all arba insert.
Rašykite HTML ir gaukite blokus
Standartiniai elementai, tokie kaip <h1>, <p> ir <ul>, susiejami su pagrindiniais blokais. Visiems kitiems blokų pavadinimams ir įdėjimo lygiams naudokite <block>.
Blockstudio išanalizuoja visus puslapio išdėstymus ir paverčia juos tikrais, redaguojamais WordPress blokais.
<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>Puslapiai, atvaizduojami komponentais
Nustatykite render faile page.json į tokį įrašą kaip page.tsx ir data.php įkėlimo funkciją – tada jūsų temos arba įskiepio užregistruotas puslapių atvaizduoklis pateiks visą puslapį. Sinchronizuojant saugomas vienas blockstudio/page blokas, o WordPress turinys, pavyzdžiui, trumpasis kodas, lieka savo vietoje.
Atvaizduoklio grąžinti ištekliai apdorojami taip pat kaip blokų ištekliai ir įterpiami tik kartą, todėl iš anksto atvaizduotas puslapis juos turi. Pats blockstudio.dev sudarytas iš komponentų puslapių.
{
"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',
)
);
}
);Maršrutai be įrašo
Blockstudio\Virtual_Routes::register() pateikia dokumentą, už kurio nėra įrašo, pavyzdžiui, komponento aprašą arba katalogą. Naudojant prefix ir match, viena registracija aptarnauja visą URL šeimą, o grąžinus null paliekama galimybė URL atlikti WordPress.
Maršrutas atvaizduojamas Blockstudio išvesties buferyje, todėl jo blokai gauna išteklius ir Tailwind išvestį. Keliai faile urls įtraukiami į statinio išankstinio atvaizdavimo kūrinius, o Virtual_Routes::urls() juos pateikia svetainės schemos žemėlapiui.
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(),
]
);
} );Sinchronizuokite tik tada, kai nurodote
Puslapių failai keičiami WordPress tik jums paprašius. wp bs pages sync pritaiko kiekvieną pakeistą šaltinį, išsaugo raktais susietą redaktoriaus turinį ir pašalina puslapius, kurių failų nebėra.
Kontrolinės sumos apima aprašus, įkėliklius, išdėstymus ir šaltinius, todėl nepakitusiems puslapiams nereikia jokių įrašymo operacijų. Diegimo metu iškviečiamas Pages::reconcile(), kuris pateikia kompiuterio nuskaitomą ataskaitą.
# 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']
);
}Raktus turintys blokai išsaugo turinį
Pridėkite key prie bet kurio bloko. Kito sinchronizavimo metu raktais susieti blokai sujungia šablono atributus su esamu naudotojo turiniu, o blokai be raktų pakeičiami.
Keiskite struktūrą tarp diegimų, išsaugodami klientų turinį.
<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"
}Šablonų užrakinimo ir redagavimo režimai
"all" neleidžia atlikti pakeitimų, "contentOnly" užrakina struktūrą, bet leidžia redaguoti tekstą, o "insert" leidžia redaguoti ir keisti eiliškumą, bet ne pridėti ar pašalinti.
Perrašykite bet kurį elementą naudodami blockEditingMode, kad užrakintame puslapyje galėtumėte pasirinktinai leisti redaguoti arba išjungti atskirą 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"
}Svetainės redaktoriaus šablonai iš failų
Pridėkite template.json ir šabloną prie templates/ arba part.json prie parts/, ir jūsų blokų tema gaus failais pagrįstus wp_template bei wp_template_part šaltinius.
Naudojama ta pati sintaksė kaip puslapiuose. Svetainės redaktoriuje atliktas tinkinimas išlieka viršesnis, kol kas nors jį nenustato iš naujo; tada vėl naudojamas failo šaltinis.
<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"
}Pasirinktas duomenų bazės turinys faile git
wp bs content pull projektai eksportuoja į leidžiamų sąrašą įtrauktus įrašus, terminus, ryšius ir deklaruotus metaduomenis į perkeliamus failus, o push juos pritaiko kitoje aplinkoje. Deklaruotos nuorodos, tėviniai įrašai ir terminų ryšiai perkeliami kaip stabilūs UID.
Puslapių sinchronizavimo valdomi įrašai gali būti susieti su includePageSyncManaged. Jų failuose yra "bodyOwner": "page-sync", todėl Content Sync perkelia metaduomenis, o puslapių sinchronizavimas išsaugo turinį.
{
"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 --yesRaktiniai blokai
Išsaugokite naudotojo turinį keičiant šablonus.
Redagavimo režimai
Nustatykite numatytuosius puslapio nustatymus ir perrašykite atskirų elementų reikšmes.
Blokų susiejimai
Susiekite blokus su įrašo metaduomenimis, kad turinys išliktų po sinchronizavimo.
Įrašų tipų šablonai
templateFor nustato puslapį kaip pradinę kiekvieno naujo tam tikro tipo įrašo blokų struktūrą.
Priskirti įrašų ID
postId išsaugo tą patį ID, kai puslapis ištrinamas ir sinchronizuojamas iš naujo, todėl meniu ir nuorodos toliau veikia.
Pradiniai šablonai ir užraktai
sync: false su Pages::force_sync() sukuria puslapį vieną kartą, kad jį tvarkytų redaktoriai. Pages::lock() ir unlock() neleidžia sinchronizuoti vieno puslapio.
Pasirinktiniai analizatoriaus atvaizduokliai
Kūrimo ir atvaizdavimo filtrai bloko žymą paverčia trečiosios šalies bloko masyvu arba pakeičia, kaip užrašomas pagrindinis blokas.
Elementų susiejimas
Susiekite HTML elementą su kitu bloku, pasirinkite bloką pagal elemento atributus ir nukreipkite pastraipos HTML į turinio lauką.
Pasirinktiniai aptikimo keliai
Filtrai prideda puslapių, šablonų rinkinių ir Site Editor šablonų šakninius katalogus, pavyzdžiui, iš įskiepio.
Loginiai aptikimo šaltiniai
Peržiūros, perdangos ir sugeneruotos temos gali pateikti Blockstudio sudarytą failų sąrašą, o ne vieną temos aplanką.
Stabilios nuorodos
Nurodytos įrašų, terminų ir priedų nuorodos atsisiunčiant tampa perkeliamais UID, o įkeliant susiejamos su vietiniais ID.
Būsena prieš įkėlimą
wp bs content status pateikia kiekvieno objekto būseną: nepakitęs, būtų atnaujintas, nėra duomenų bazėje, konfliktas, užrakintas arba našlaitis, ir įspėja apie raktus, kurie panašūs į paslaptis.
Patikrinti, apimties ribojami įkėlimai
Įkėlimo metu prieš rašant patikrinamas visas planas, o užrakinti objektai praleidžiami. –dry-run parodo planą, o –prune –yes pašalina tik šio turinio rinkinio objektus.
Versijų valdoma
Sekite puslapių failus sistemoje Git ir diekite juos skirtingose aplinkose.
PHP API
Programiškai pasiekite hierarchijas, antrinius elementus, metaduomenis, sinchronizavimą, užrakinimą ir ID.
Oficialus plėtinių rinkinys
Aukščiausios klasės svetainių šablonai, DI sistemos instrukcijos ir privati Discord bendruomenė. Vienkartinis pirkimas, atnaujinimai visam laikui.
- 500+ svetainių šablonų
- AI sistemos instrukcijos
- Naujiniai visam laikui
- Privati Discord bendruomenė