Saidi redaktori mallid ja osad failidest
Plokiteema kirjeldab paigutust failides templates/*.html ja parts/*.html: need on failid, mis sisaldavad serialiseeritud plokikommentaare, näiteks <!-- wp:template-part {"slug":"header"} /-->. Keegi ei taha neid käsitsi kirjutada, seega luuakse need tavaliselt saidi redaktoris ja eksporditakse. See toimib seni, kuni kaks inimest muudavad sama malli või ülevaataja peab lugema paomärkidega JSON-i sisaldavate HTML kommentaaride muudatuste võrdlust.
Blockstudio võimaldab kirjutada samu malle failipõhiste lehtede moodi: loote kausta väikese JSON manifesti ja HTML-laadse märgistusega lähtefaili, kasutades tavalisi elemente, <block> silte ja enda Blockstudio plokke. Blockstudio kompileerib lähtekoodi loomulikuks plokimärgistuseks ja edastab selle WordPress-ile teemafailina. Saidi redaktor töötab endiselt nagu varem: kasutajad saavad malli kohandada ning lähtestamisel taastub failiversioon.
See juhend loob päise ja jaluse osa, avalehe ja üksikvaate mallid ning kohandatud malli, mille toimetajad saavad lehtedele valida, ja näitab seejärel, kuidas WordPress need tuvastab.
Kaustastruktuur
Mallid asuvad kaustas templates/, malliosad kaustas parts/. Igaüks neist on manifesti ja ühe lähtefailiga kaust:
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
Need on samad kaustad templates/ ja parts/, mida WordPress plokiteema puhul loeb. Blockstudio otsib esmalt aktiivsest teemast ja seejärel ülemteemast. Kaustad, milles on template.json või part.json, on Blockstudio-i lähtefailid; nende kõrval asuvad tavalised .html-failid jäävad loomulikeks WordPress-mallideks.
Lähtefail võib olla index.php, index.blade.php, index.twig või index.html, selles järjekorras. Twig vajab paketti Timber ja Blade vajab oma renderduspaketti, nagu kirjeldatakse jaotises Mallimootorid.
1. samm: päiseosa
Iga osa vajab faili part.json. area ütleb saidi redaktorile, kuhu see osa kuulub:
{
"slug": "header",
"title": "Header",
"description": "Site header with logo and navigation",
"area": "header"
}
Lähtefail kasutab sama süntaksit nagu Blockstudio lehed ja mustrid. <div> muutub grupiplokiks, atribuutidest saavad ploki atribuudid ning <block>-elemendid loovad mis tahes registreeritud ploki:
<div layout='{"type":"flex","justifyContent":"space-between"}'>
<block name="core/site-title" />
<block name="core/navigation" overlayMenu="mobile" />
</div>
Blockstudio kompileerib selle plokimärgistuseks:
<!-- 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 -->
Selle oleksite muidu käsitsi kirjutanud. Ka teie enda plokid töötavad samamoodi: <block name="acme/announcement" />, <bs:acme-announcement /> silt või konfigureeritud sildi eesliide kompileeritakse kõik selle ploki kommentaariks.
2. samm: jaluseosa
Osa võib koosneda vaid ühest lõigust. See kasutab index.html-i, et näidata, et lähtekood on märgistuskeel, mitte programm:
{
"slug": "footer",
"title": "Footer",
"area": "footer"
}
<p>Built with Acme.</p>
See kompileeritakse kujule <!-- wp:paragraph --><p>Built with Acme.</p><!-- /wp:paragraph -->.
3. samm: avalehe ja üksikvaate mallid
Mallid kasutavad template.json-i. slug peab olema täpne WordPress mallihierarhia nimi, näiteks front-page, single, page, archive, 404 või single-product. Blockstudio seda kunagi eesliitena ei lisa.
{
"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" />
Üksikpostituse mall järgib sama struktuuri postitusplokkidega:
{
"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" />
Kompileeritud üksikvaate mall:
<!-- 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> muutus atribuudiga tagName: "main" grupiplokiks ning malliosa plokid viitavad 1. ja 2. sammus loodud osadele nende lühinime järgi. Kui WordPress malli renderdab, viitavad need failipõhistele osadele, nii et avalehe väljund algab <header class="wp-block-template-part">-iga, mis sisaldab saidi pealkirja ja navigeerimist, ning lõpeb <footer class="wp-block-template-part">-iga, mis sisaldab jaluse lõiku.
4. samm: lehtede kohandatud mall
Mallid, mille lühinimi ei kuulu hierarhiasse, on kohandatud mallid. Loetlege atribuudiga postTypes postitustüübid, millele need kehtivad, ja toimetajad saavad need mallivalijast valida:
{
"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' ) sisaldab nüüd page-landing-i ning malliobjekt sisaldab välja post_types: ["page"].
Lähtefailid kompileeritakse üks kord
Lähtefail loetakse ja kompileeritakse plokimärgistuseks üks kord, mitte iga päringuga. Sellel pole praegust postitust ega päringu konteksti. index.php loetakse märgistuskeelena: selles olevat PHP koodi ei käivitata, seega kompileeritakse <?php echo get_bloginfo( 'name' ); ?> tühjaks. Kõik päringust sõltuv kuulub käitusaegses plokis renderdamisse: näiteks saidi nime väljaprintimise asemel core/site-title, the_title() asemel core/post-title või teie enda dünaamiline Blockstudio plokk.
Kompileeritud tulemused salvestatakse vahemällu koos failide jälgimise metaandmetega. Manifesti või lähtefaili muutmine tühistab selle üksuse vahemällu salvestatud sisu, nii et järgmine päring näeb muudatust ilma eraldi ehitussammuta.
Kuidas WordPress faile näeb
Blockstudio kasutab samu otsinguid, mida WordPress teemamallide puhul. get_block_templates() kuvatakse failipõhised mallid kui source: "theme" ja origin: "theme", nagu loomulikud teemafailidki, ning get_block_template( 'acme//header', 'wp_template_part' ) tagastab päiseosa koos selle area-iga.
Otsingujärjestus on järgmine:
- Andmebaasi salvestatud saidi redaktori kohandus.
- Aktiivse teema loomulik
.html-fail. - Failipõhine lähtefail Blockstudio.
- Ülemteema või plugina varuvariandid.
See järjestus säilitab saidi redaktori töövoo. Kui kasutaja muudab jalust ja salvestab selle, salvestab WordPress wp_template_part postituse ning get_block_template() tagastab selle kohanduse koos väljaga source: "custom". Hilisemad muudatused failis parts/footer/index.html ei kajastu seni, kuni kohandus on olemas. Kui kasutaja lähtestab osa või postitus kustutatakse, pöördub otsing tagasi faili juurde ning tagastab taas uusima kompileeritud lähteversiooni.
Blockstudio ei kirjuta saidi redaktoris tehtud muudatusi failidesse. Kui kasutaja muudatusest peab saama uus vaikeväärtus, kopeerige see lähtefaili ja lähtestage kohandus.
Pesastatud index.html ja lühinimed
WordPress leiab rekursiivselt .html-faile asukohtadest templates/ ja parts/. Seetõttu kuvataks ka manifestikaust, mis kasutab index.html-i (näiteks parts/footer/index.html), loomuliku osana, mille lühinimi tuleneb teest: footer/index. Kuna Blockstudio 7.6.6, kuvatakse manifestiga hallatav index.html ainult selle määratud lühinime all, nii et saidi redaktor loetleb ühe jaluse, mitte kaks. Pesastatud .html-failid, millel manifest puudub, jäetakse puutumata.
Mallide kontrollimine PHP kaudu
Klass Blockstudio\Site_Templates loeb lähtefailid ja kompileerib need, mis on kasulik testides ja juurutamise kontrollides:
$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();
Iga üksus sisaldab väärtusi slug, title, description ja type (kas wp_template või wp_template_part), samuti status, source_type, mallide puhul postTypes või osade puhul area, meta ning kompileeritud content. Ainult valitud üksuste kompileerimiseks edastage loend, seejärel lugege selle valiku probleemid atribuudiga selection_errors():
$selected = Blockstudio\Site_Templates::templates( array( 'front-page' ) );
$errors = Blockstudio\Site_Templates::selection_errors( 'templates' );
Muude kaustade lisamine
Et hoida Blockstudio lähtefailid loomulikest mallidest eraldi või pakkuda neid plugina kaudu, lisage filtritega otsinguteekonnad:
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;
} );
Filtrid blockstudio/site_templates/template_content ja part_content muudavad lähtefaili enne selle parsimist ning blockstudio/site_templates/parser asendab ühe üksuse parseri. Täieliku loendi leiate saidi mallide hook’ide tabelist.
Millal mida kasutada
| Soovite | Kasutage |
|---|---|
| Teema paigutuse WordPress valib URL jaoks: päis, jalus, üksikvaade, arhiiv | Saidi mallid ja osad |
| Failides oleva sisuga marsruuditavat lehte | Failipõhised lehed |
| Korduskasutatavat jaotist, mille toimetajad lisavad | Mustrid |
Mallid ei loo postitusi, seda teevad lehed. Näiteks dokumentatsiooni jaotis on lehekogum, mille postitused renderdatakse malli kaudu, mida saate siin endiselt luua.
Järgmised sammud
- Saidi mallide viide: kõik manifesti atribuudid, PHP API ja kõik hook’id.
- Lehtede ja mustrite ülevaade: mallide lähtefailides kasutatavad HTML parser, plokisildid ja elementide vastendus.
- Dokumendisaidi loomine: lehekogumid, mis kasutavad Markdown-i, laadureid ja paigutusi.