Svetainės redaktoriaus šablonai ir dalys iš failų
Blokų tema savo išdėstymą aprašo templates/*.html ir parts/*.html:
failuose pilna serializuotų blokų komentarų, tokių kaip
<!-- wp:template-part {"slug":"header"} /-->. Niekam nepatinka juos rašyti
rankiniu būdu, todėl paprastai jie sukuriami svetainės redaktoriuje ir eksportuojami. Tai veikia,
kol du žmonės redaguoja tą patį šabloną arba recenzentui tenka skaityti
pabėgintuosius JSON HTML komentaruose.
Blockstudio leidžia rašyti tuos pačius šablonus taip, kaip rašote failais pagrįstus
puslapius: aplanke yra nedidelis JSON manifestas ir šaltinio failas su į HTML panašiu
žymėjimu, kuriame naudojami paprasti elementai, <block> žymos ir jūsų pačių Blockstudio blokai.
Blockstudio sukompiliuoja šaltinį į savąjį blokų žymėjimą ir perduoda jį WordPress
kaip temos failą. Svetainės redaktorius veikia kaip anksčiau: naudotojai gali
tinkinti šabloną, o jį nustačius iš naujo atkuriama failo versija.
Šiame vadove sukursime antraštės ir poraštės dalis, pagrindinio puslapio ir įrašo šablonus, taip pat pasirinktinį šabloną, kurį redaktoriai galės pasirinkti puslapiams, o tada parodysime, kaip WordPress juos parenka.
Aplankų struktūra
Šablonai laikomi templates/, o šablonų dalys – parts/. Kiekviena yra aplankas
su manifestu ir vienu šaltinio failu:
theme/
├── templates/
│ ├── front-page/
│ │ ├── template.json
│ │ └── index.php
│ ├── single/
│ │ ├── template.json
│ │ └── index.php
│ └── page-landing/
│ ├── template.json
│ └── index.php
└── parts/
├── header/
│ ├── part.json
│ └── index.php
└── footer/
├── part.json
└── index.html
Tai tie patys aplankai templates/ ir parts/, kuriuos WordPress nuskaito blokų
temai. Blockstudio pirmiausia peržiūri aktyvią temą, o tada pagrindinę.
Aplankai su template.json arba part.json yra Blockstudio šaltiniai; šalia jų esantys paprasti
.html failai lieka savaisiais WordPress šablonais.
Šaltinio failas gali būti index.php, index.blade.php, index.twig arba
index.html; tikrinama nurodyta tvarka. Twig reikia Timber, o Blade reikia jo
atvaizdavimo paketo, kaip aprašyta skiltyje
Šablonų varikliai.
1 žingsnis: antraštės dalis
Kiekvienai daliai reikia part.json. area nurodo svetainės redaktoriui, kuriai vietai dalis
skirta:
{
"slug": "header",
"title": "Header",
"description": "Site header with logo and navigation",
"area": "header"
}
Šaltinyje naudojama ta pati sintaksė kaip Blockstudio puslapiuose ir šablonuose. <div>
tampa grupės bloku, atributai – blokų atributais, o <block>
elementai sukuria bet kurį užregistruotą bloką:
<div layout='{"type":"flex","justifyContent":"space-between"}'>
<block name="core/site-title" />
<block name="core/navigation" overlayMenu="mobile" />
</div>
Blockstudio sukompiliuoja jį į šį blokų žymėjimą:
<!-- wp:group {"layout":{"type":"flex","justifyContent":"space-between"}} --><div class="wp-block-group is-layout-flex"><!-- wp:site-title /--><!-- wp:navigation {"overlayMenu":"mobile"} /--></div><!-- /wp:group -->
Būtent taip būtumėte tai užrašę rankiniu būdu. Jūsų blokai veikia taip pat: <block name="acme/announcement" />, žyma <bs:acme-announcement />
arba sukonfigūruotas žymos prefiksas – visa tai sukompiliuojama į to
bloko komentarą.
2 žingsnis: poraštės dalis
Dalį gali sudaryti vos viena pastraipa. Šiame pavyzdyje naudojamas index.html, kad būtų aišku,
jog šaltinis yra žymėjimas, o ne programa:
{
"slug": "footer",
"title": "Footer",
"area": "footer"
}
<p>Built with Acme.</p>
Jis sukompiliuojamas į <!-- wp:paragraph --><p>Built with Acme.</p><!-- /wp:paragraph -->.
3 žingsnis: pagrindinio puslapio ir įrašo šablonai
Šablonams naudojama template.json. slug turi tiksliai atitikti WordPress šablonų hierarchijos pavadinimą, pvz., front-page, single, page, archive, 404 arba single-product. Blockstudio niekada neįterpiamas kaip prefiksas.
{
"slug": "front-page",
"title": "Front Page",
"description": "Homepage template"
}
<block name="core/template-part" slug="header" tagName="header" />
<main>
<block name="core/post-content" />
</main>
<block name="core/template-part" slug="footer" tagName="footer" />
Vieno įrašo šablono struktūra tokia pati, tik naudojami įrašo blokai:
{
"slug": "single",
"title": "Single Post"
}
<block name="core/template-part" slug="header" tagName="header" />
<main>
<block name="core/post-title" level="1" />
<block name="core/post-date" />
<block name="core/post-content" />
</main>
<block name="core/template-part" slug="footer" tagName="footer" />
Sukompiliuotas vieno įrašo šablonas:
<!-- wp:template-part {"slug":"header","tagName":"header"} /--><!-- wp:group {"tagName":"main"} --><main class="wp-block-group"><!-- wp:post-title {"level":1} /--><!-- wp:post-date /--><!-- wp:post-content /--></main><!-- /wp:group --><!-- wp:template-part {"slug":"footer","tagName":"footer"} /-->
<main> tapo grupės bloku su tagName: "main", o šablono dalių blokai nurodo 1 ir 2 žingsniuose sukurtas dalis pagal trumpąjį pavadinimą. Kai WordPress atvaizduoja šabloną, nuorodos nukreipia į failais pagrįstas dalis, todėl pagrindinio puslapio išvestis prasideda <header class="wp-block-template-part"> su svetainės pavadinimu
ir navigacija, o baigiasi <footer class="wp-block-template-part"> su poraštės pastraipa.
4 žingsnis: pasirinktinis puslapių šablonas
Šablonai, kurių trumpieji pavadinimai nepriklauso hierarchijai, yra pasirinktiniai. Nurodykite jiems taikomus įrašų tipus naudodami postTypes, o redaktoriai galės juos pasirinkti šablonų parinkiklyje:
{
"slug": "page-landing",
"title": "Landing Page",
"description": "Full-width page without a header",
"postTypes": ["page"]
}
<main>
<block name="core/post-content" />
</main>
<block name="core/template-part" slug="footer" tagName="footer" />
get_block_templates( array( 'post_type' => 'page' ), 'wp_template' ) dabar
apima page-landing, o šablono objekte yra post_types: ["page"].
Šaltiniai kompiliuojami vieną kartą
Šaltinis nuskaitomas ir sukompiliuojamas į blokų žymėjimą vieną kartą, o ne kiekvienos užklausos metu. Jis neturi dabartinio įrašo ar užklausos konteksto. index.php skaitomas kaip žymėjimas: jame esantis PHP kodas nevykdomas, todėl <?php echo get_bloginfo( 'name' ); ?> sukompiliuojamas į tuščią rezultatą. Viskas, kas priklauso nuo užklausos, turi būti bloke, kuris atvaizduojamas vykdymo metu: core/site-title vietoj išvesto svetainės pavadinimo, core/post-title vietoj the_title() arba jūsų sukurtas dinaminis Blockstudio blokas.
Sukompiliuoti rezultatai talpykloje saugomi kartu su failų stebėjimo metaduomenimis. Redaguojant manifestą arba šaltinio failą, panaikinamas atitinkamo elemento talpyklos įrašas, todėl kitoje užklausoje pakeitimas matomas be atskiro kompiliavimo žingsnio.
Kaip WordPress aptinka failus
Blockstudio naudoja tas pačias paieškos funkcijas kaip WordPress temų šablonams. get_block_templates() failais pagrįsti šablonai rodomi su source: "theme" ir origin: "theme", kaip ir savieji temos failai, o get_block_template( 'acme//header', 'wp_template_part' ) grąžina antraštės
dalį su jos area.
Paieškos tvarka:
- Svetainės redaktoriaus tinkinimas, saugomas duomenų bazėje.
- Savasis
.htmlfailas aktyvioje temoje. - Failais pagrįstas Blockstudio šaltinis.
- Pagrindinės temos arba įskiepių atsarginiai variantai.
Tokia tvarka išlaikomas svetainės redaktoriaus procesas. Kai naudotojas redaguoja poraštę ir ją išsaugo, WordPress išsaugo wp_template_part įrašą, o get_block_template() grąžina tą tinkinimą su source: "custom".
Vėlesni parts/footer/index.html pakeitimai nerodomi, kol tinkinimas egzistuoja. Kai naudotojas iš naujo nustato dalį arba įrašas ištrinamas, paieška grįžta prie failo ir vėl grąžina naujausią sukompiliuotą šaltinį.
Blockstudio neįrašo svetainės redaktoriaus pakeitimų į failus. Jei naudotojo pakeitimas turi tapti naujuoju numatytuoju variantu, nukopijuokite jį į šaltinio failą ir iš naujo nustatykite tinkinimą.
Įdėtiniai index.html ir trumpieji pavadinimai
WordPress rekursyviai aptinka .html failus kataloguose templates/ ir parts/. Taigi manifesto aplankas, kuriame naudojamas index.html, pvz., parts/footer/index.html, taip pat būtų rodomas kaip savoji dalis su pagal kelią sudarytu trumpuoju pavadinimu footer/index. Kadangi Blockstudio 7.6.6, manifesto valdomas index.html pateikiamas tik nurodytu trumpuoju pavadinimu, todėl svetainės redaktoriuje pateikiama viena poraštė, o ne dvi. Įdėtiniai .html failai be manifesto nekeičiami.
Šablonų tikrinimas iš PHP
Blockstudio\Site_Templates klasė nuskaito ir sukompiliuoja šaltinius; tai naudinga atliekant bandymus ir diegimo patikras:
$templates = Blockstudio\Site_Templates::templates();
$header = Blockstudio\Site_Templates::get_part( 'header' );
echo $header['area']; // header
echo $header['content']; // compiled block markup
$errors = Blockstudio\Site_Templates::errors();
Kiekviename elemente yra slug, title, description, type (wp_template arba wp_template_part), status, source_type, šablonų atveju – postTypes, o dalių atveju – area, taip pat meta ir sukompiliuotas content. Perduokite sąrašą, kad būtų kompiliuojami tik pasirinkti elementai, o su ta atranka susijusias problemas peržiūrėkite naudodami selection_errors():
$selected = Blockstudio\Site_Templates::templates( array( 'front-page' ) );
$errors = Blockstudio\Site_Templates::selection_errors( 'templates' );
Kitų aplankų pridėjimas
Kad Blockstudio šaltiniai būtų atskirti nuo savųjų šablonų arba juos būtų galima pateikti su įskiepiu, pridėkite aptikimo šaknis su filtrais:
add_filter( 'blockstudio/site_templates/template_paths', function ( $paths ) {
$paths[] = get_stylesheet_directory() . '/site-templates';
return $paths;
} );
add_filter( 'blockstudio/site_templates/part_paths', function ( $paths ) {
$paths[] = get_stylesheet_directory() . '/site-parts';
return $paths;
} );
Filtrai blockstudio/site_templates/template_content ir part_content pakeičia šaltinį prieš jį analizuojant, o blockstudio/site_templates/parser pakeičia vieno elemento analizatorių. Visas sąrašas pateiktas skiltyje Svetainės šablonų kablių lentelė.
Kada ką naudoti
| Ko norite | Naudokite |
|---|---|
| Temos išdėstymo WordPress šablono, skirto URL: antraštei, poraštei, vienam įrašui, archyvui | Svetainės šablonus ir dalis |
| Puslapio su URL maršrutu, kurio turinys laikomas failuose | Puslapiai iš failų |
| Pakartotinai naudojamos skilties, kurią įterpia redaktoriai | Šablonai |
Šablonai nesukuria įrašų. Juos sukuria puslapiai. Pavyzdžiui, dokumentacijos skiltis yra puslapių rinkinys, kurio įrašai atvaizduojami naudojant čia kuriamą šabloną.
Tolesni žingsniai
- Svetainės šablonų žinynas: visos manifesto ypatybės, PHP API ir visi kabliai.
- Puslapių ir šablonų apžvalga: HTML analizatorius, blokų žymos ir elementų susiejimas, naudojamas šablonų šaltiniuose.
- Dokumentacijos svetainės kūrimas: puslapių rinkiniai su Markdown, duomenų įkėlimo funkcijomis ir išdėstymais.