Pilnas lapas, definētas kodā
Veidnes un Markdown tiek sinhronizētas ar WordPress ar vienu komandu.
Kolekcijas no failiem
Definējiet pages.json, un ļaujiet Blockstudio atrast visus zem tā esošos avotus. Ligzdotie ceļi kļūst par ligzdotām lapām, noklusējuma vērtības attiecas uz kolekciju, un trūkstošās vecāklapas var izveidot automātiski.
Izmantojiet kolekcijas dokumentācijai, zināšanu bāzēm vai galvenajām lapām, bet ārējās mapes pievienojiet ceļa prefiksam ar loader.php.
Novietojiet layout.php vai renderētāja izkārtojumu, piemēram, layout.tsx, blakus pages.json, lai ietvertu katru kolekcijas lapu vienā ietvarā, izmantojot blockstudio_page_tree() sānjoslai.
{
"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>Skaidra sinhronizēšana
wp bs pages sync piemēro izmaiņas; nemainītām lapām nav vajadzīgi rakstīšanas pieprasījumi.
Markdown avoti
Izmantojiet index.md ar priekšējās informācijas bloku vai savienojiet page.json ar Markdown saturu.
Neapstrādāts Markdown
Markdown failu lapas ir pieejamas to URL kopā ar .md vai parastajā URL, ja pieprasījumā ir Accept: text/markdown, un tām ir kanoniskā saite atpakaļ uz HTML.
Kolekciju ielādētāji
Pievienojiet ārējās dokumentācijas mapes kolekcijai zem ceļa prefiksa.
Vietņu kolekcijas
pages.json ar vietnes tvērumu piemēro kopīgos noklusējuma iestatījumus visam lapu kokam un uzskaita to, nemainot URL vai ziņu ierakstus.
Navigācijas palīgfunkcijas
blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() un blockstudio_page_content() veido sānjoslas, lappušu navigāciju un pamattekstu.
Kolekcijas un ziņu tipi
Kolekcijas var reģistrēt īpašus hierarhiskus ziņu tipus.
Veidnes struktūras bloķēšana
Bloķējiet lapas vai atsevišķus blokus ar contentOnly, all vai insert.
Rakstiet HTML, iegūstiet blokus
Standarta elementi, piemēram, <h1>, <p> un <ul>, tiek sasaistīti ar pamata blokiem. Izmantojiet <block> visiem pārējiem bloku nosaukumiem un ligzdošanas līmeņiem.
Blockstudio parsē pilnus lapu izkārtojumus īstos, rediģējamos WordPress blokos.
<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>Lapas, ko renderē komponenti
Iestatiet render failā page.json uz ierakstu, piemēram, page.tsx, un data.php ielādētāju; lapas renderētājs, ko reģistrē jūsu tēma vai spraudnis, izveido visu lapu. Sinhronizācija saglabā vienu blockstudio/page bloku, bet WordPress saturs, piemēram, īskods, paliek savā vietā.
Renderētāja atgrieztie resursi tiek apstrādāti tāpat kā bloku resursi un izvadīti tikai vienreiz, tāpēc iepriekš renderētā lapa tos satur. Pats blockstudio.dev tiek veidots no komponentu lapām.
{
"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šruti bez ziņas
Blockstudio\Virtual_Routes::register() apkalpo dokumentu, aiz kura nav ziņas, piemēram, komponenta aprakstu vai katalogu. Ar prefix un match viena reģistrācija apkalpo visu URL saimi, bet, atgriežot null, URL tiek nodots WordPress.
Maršruts tiek renderēts Blockstudio izvades buferī, tāpēc tā bloki saņem savus resursus un Tailwind izvadi. Ceļi no urls tiek iekļauti statiskās iepriekšējās renderēšanas būvējumos, bet Virtual_Routes::urls() tos atgriež vietnes kartei.
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(),
]
);
} );Sinhronizējiet tikai pēc pieprasījuma
Lapu faili tiek mainīti WordPress tikai pēc jūsu pieprasījuma. wp bs pages sync lieto visas izmainītās avota datnes, saglabā redaktorā veidoto saturu ar atslēgām un dzēš lapas, kuru failu vairs nav.
Kontrolsummas aptver manifestus, ielādētājus, izkārtojumus un avotus, tāpēc nemainītām lapām nav vajadzīgi rakstīšanas pieprasījumi. Izvietošanas procesi izsauc Pages::reconcile() un saņem mašīnlasāmu pārskatu.
# 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']
);
}Bloki ar atslēgām saglabā saturu
Pievienojiet key jebkuram blokam. Nākamajā sinhronizācijā bloki ar atslēgām apvieno veidnes atribūtus ar esošo lietotāja saturu, bet bloki bez atslēgām tiek aizstāti.
Mainiet struktūru starp izvietošanām, saglabājot klientu saturu.
<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"
}Veidņu bloķēšana un rediģēšanas režīmi
"all" nepieļauj izmaiņas, "contentOnly" bloķē struktūru, taču ļauj rediģēt tekstu, bet "insert" ļauj rediģēt un mainīt secību, nepievienojot vai nenoņemot saturu.
Aizstājiet jebkuru elementu ar blockEditingMode, lai bloķētu lapu un ļautu rediģēt tikai noteiktas daļas vai atspējotu atsevišķu bloku.
<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"
}Vietnes redaktora veidnes no failiem
Pievienojiet template.json un veidni failam templates/ vai part.json uz parts/, un jūsu bloku tēma iegūs failu nodrošinātus wp_template un wp_template_part avotus.
Tajās izmanto to pašu sintaksi, ko lapās. Vietnes redaktora pielāgojumi paliek spēkā līdz to atiestatīšanai, pēc tam atkal tiek izmantots faila avots.
<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"
}Atlasīts datubāzes saturs git
wp bs content pull eksportē atļautos ierakstus, terminus, saistības un deklarētos metadatus pārnesamos failos, bet push tos lieto citā vidē. Deklarētās atsauces, vecāki un terminu saistības tiek pārnestas kā nemainīgi UID.
Ar lapu sinhronizāciju pārvaldītās ziņas var izmantot kopā ar includePageSyncManaged. To failos ir "bodyOwner": "page-sync", tāpēc Content Sync pārvieto metadatus, bet lapu sinhronizācija saglabā pamattekstu.
{
"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 --yesAr atslēgām apzīmēti bloki
Saglabājiet lietotāju saturu, kamēr veidnes tiek pilnveidotas.
Rediģēšanas režīmi
Iestatiet lapas noklusējuma vērtības un atsevišķu elementu aizstājējus.
Block Bindings
Savienojiet blokus ar ziņu metadatiem, lai saturs saglabātos arī pēc sinhronizācijas.
Ziņu veidu veidnes
templateFor padara lapu par sākotnējo bloku struktūru katrai jaunai attiecīgā veida ziņai.
Piesprausti ziņu ID
postId atjauno to pašu ID, kad lapa tiek dzēsta un sinhronizēta vēlreiz, tāpēc izvēlnes un saites turpina darboties.
Sagataves un bloķēšana
sync: false kopā ar Pages::force_sync() izveido lapu vienreiz, lai redaktori to pārvaldītu. Pages::lock() un unlock() neļauj vienai lapai piedalīties sinhronizācijā.
Pielāgoti parsētāja renderētāji
Veidotāja un renderētāja filtri pārvērš bloka tagu trešās puses bloka masīvā vai maina to, kā tiek rakstīts pamata bloks.
Elementu kartēšana
Kartējiet HTML elementu uz citu bloku, izvēlieties bloku pēc elementa atribūtiem un novirziet rindkopas HTML uz satura lauku.
Pielāgoti atklāšanas ceļi
Filtri pievieno saknes lapām, paraugiem un Site Editor veidnēm, piemēram, no spraudņa.
Loģiskie atklāšanas avoti
Priekšskatījumi, pārklājumi un ģenerētas tēmas var nodot Blockstudio saliktu failu sarakstu vienas tēmas mapes vietā.
Stabilas atsauces
Deklarētās ziņu, terminu un pielikumu atsauces izgūšanas laikā kļūst par pārnesamiem UID, bet nosūtīšanas laikā tiek sasaistītas ar lokālajiem ID.
Statuss pirms nosūtīšanas
wp bs content status ziņo par katru vienību kā nemainītu, atjaunināmu, trūkstošu datubāzē, konfliktējošu, bloķētu vai bāreņvienību, kā arī brīdina par metadatu atslēgām, kas izskatās pēc slepeniem datiem.
Validēta nosūtīšana ar tvērumu
Nosūtīšana validē visu plānu pirms rakstīšanas un izlaiž bloķētās vienības. –dry-run parāda plānu, bet –prune –yes noņem tikai šīs satura kopas vienības.
Versiju kontrolēts
Sekojiet lapu failiem Git un izvietojiet tos dažādās vidēs.
PHP API
Programmiski piekļūstiet kokiem, apakšelementiem, metadatiem, sinhronizācijai, bloķēšanai un ID.
Oficiālais paplašinājumu komplekts
Premium vietņu veidnes, AI sistēmas instrukcijas un privāta Discord kopiena. Vienreizējs pirkums, atjauninājumi uz mūžu.
- 500+ vietņu veidnes
- AI sistēmas instrukcijas
- Atjauninājumi visā lietošanas laikā
- Privāta Discord kopiena