Sivustoeditorin mallipohjat ja osat tiedostoista
Lohkoteema määrittelee asettelunsa tiedostoissa templates/*.html ja parts/*.html:
tiedostot sisältävät sarjoitettuja lohkokommentteja, kuten
<!-- wp:template-part {"slug":"header"} /-->. Kukaan ei pidä niiden kirjoittamisesta
käsin, joten ne luodaan yleensä Sivustoeditorissa ja viedään tiedostoihin. Tämä toimii siihen asti, kunnes kaksi ihmistä muokkaa samaa mallipohjaa tai tarkastajan täytyy lukea erotusmerkintöjä, joissa on escape-koodattua JSON-merkintää HTML-kommenteissa.
Blockstudio-toiminnolla voit kirjoittaa samat mallipohjat samalla tavalla kuin tiedostopohjaiset
sivut: kansioon lisätään pieni JSON-manifesti ja lähdetiedosto, jossa on HTML-tyyppistä
merkintää. Siinä käytetään tavallisia elementtejä, <block>-tageja ja omia Blockstudio-lohkojasi.
Blockstudio kääntää lähteen alkuperäiseksi lohkomerkinnäksi ja välittää sen WordPresslle
teematiedostona. Sivustoeditori toimii edelleen kuten ennenkin: käyttäjät voivat
mukauttaa mallipohjaa, ja sen palauttaminen tuo tiedostoversion takaisin.
Tässä oppaassa luodaan ylä- ja alatunnisteen osa, etusivun ja yksittäisen sisällön mallipohjat sekä mukautettu mallipohja, jonka editorit voivat valita sivuille. Lopuksi näytetään, miten WordPress löytää ne.
Kansiorakenne
Mallipohjat sijoitetaan hakemistoon templates/ ja mallipohjan osat hakemistoon parts/. Kumpikin on kansio,
jossa on manifesti ja yksi lähdetiedosto:
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
Nämä ovat samat templates/– ja parts/-kansiot, joista WordPress lukee lohko-
teeman. Blockstudio käy ensin läpi aktiivisen teeman ja sitten emoteeman.
Kansiot, joissa on template.json tai part.json, ovat Blockstudio-lähteitä; niiden vieressä olevat tavalliset
.html-tiedostot pysyvät alkuperäisinä WordPress-mallipohjina.
Lähdetiedosto voi olla index.php, index.blade.php, index.twig tai
index.html, tässä järjestyksessä. Twig vaatii Timbern ja Blade vaatii renderöijäpakettinsa, kuten kuvataan
kohdassa
Mallipohjamoottorit.
Vaihe 1: Ylätunnisteen osa
Jokainen osa tarvitsee arvon part.json. area määrittää Sivustoeditorille osan
sijainnin:
{
"slug": "header",
"title": "Header",
"description": "Site header with logo and navigation",
"area": "header"
}
Lähde käyttää samaa syntaksia kuin Blockstudio-sivut ja -kuviot. <div>
muuttuu ryhmälohkoksi, määritteistä tulee lohkomääritteitä ja <block>
elementit tuottavat rekisteröidyn lohkon:
<div layout='{"type":"flex","justifyContent":"space-between"}'>
<block name="core/site-title" />
<block name="core/navigation" overlayMenu="mobile" />
</div>
Blockstudio kääntää sen tähän lohkomerkintään:
<!-- 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 -->
Tämän olisit muuten kirjoittanut käsin. Omat lohkot toimivat samalla tavalla: <block name="acme/announcement" />, <bs:acme-announcement />-tunniste
tai määritetty tunniste-etuliite kääntyvät kaikki kyseisen lohkon lohkokommentiksi.
Vaihe 2: Alatunnisteen osa
Osa voi olla niinkin pieni kuin yksi kappale. Tässä index.html havainnollistaa,
että lähde on merkintää eikä ohjelma:
{
"slug": "footer",
"title": "Footer",
"area": "footer"
}
<p>Built with Acme.</p>
Se käännetään muotoon <!-- wp:paragraph --><p>Built with Acme.</p><!-- /wp:paragraph -->.
Vaihe 3: Etusivun ja yksittäisen sisällön mallipohjat
Mallipohjissa käytetään template.json-arvoa. slug-arvon on oltava täsmällinen WordPress-mallipohjahierarkian nimi, kuten front-page, single, page, archive, 404 tai single-product. Blockstudio ei koskaan toimi sen etuliitteenä.
{
"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" />
Yksittäisen artikkelin mallipohja noudattaa samaa rakennetta artikkelilohkoineen:
{
"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" />
Käännetty yksittäisen artikkelin mallipohja:
<!-- 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> muuttui ryhmälohkoksi, jolla on määrite tagName: "main". Mallipohjan osalohkot viittaavat vaiheiden 1 ja 2 osiin etuliitteen avulla. Kun WordPress hahmontaa mallipohjan, viittaukset yhdistyvät tiedostopohjaisiin osiin. Siksi etusivun tuloste alkaa <header class="wp-block-template-part">-osalla, joka sisältää sivuston nimen ja navigoinnin, ja päättyy <footer class="wp-block-template-part">-osaan, joka sisältää alatunnisteen kappaleen.
Vaihe 4: Mukautettu mallipohja sivuille
Mallipohjat, joiden etuliite ei kuulu hierarkiaan, ovat mukautettuja mallipohjia. Luettele postTypes-arvossa niihin sovellettavat sisältötyypit, niin editorit voivat valita ne mallipohjavalikosta:
{
"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' ) sisältää nyt myös page-landingn, ja mallipohjaobjektissa on post_types: ["page"].
Lähteet käännetään kerran
Lähde luetaan ja käännetään lohkomerkinnäksi kerran, ei jokaisen pyynnön yhteydessä. Käytettävissä ei ole nykyistä artikkelia eikä pyyntökontekstia. index.php luetaan merkintänä: sen sisältämää PHP-koodia ei suoriteta, joten <?php echo get_bloginfo( 'name' ); ?> kääntyy tyhjäksi. Kaikki pyynnöstä riippuva kuuluu lohkoon, joka hahmonnetaan suorituksen aikana: core/site-title tulostetun sivuston nimen sijaan, core/post-title arvon the_title() sijaan tai oma dynaaminen Blockstudio-lohko.
Käännetyt tulokset välimuistitetaan tiedostojen tarkkailutietojen kanssa. Manifestin tai lähdetiedoston muokkaaminen mitätöi kyseisen kohteen välimuistisisällön, joten seuraava pyyntö näkee muutoksen ilman erillistä koontivaihetta.
Miten WordPress löytää tiedostot
Blockstudio käyttää samoja hakuja kuin WordPress teeman mallipohjille. Kohdassa get_block_templates() tiedostopohjaiset mallipohjat näkyvät arvoilla source: "theme" ja origin: "theme" kuten teeman alkuperäiset tiedostot, ja get_block_template( 'acme//header', 'wp_template_part' ) palauttaa ylätunnisteen osan ja sen area-arvon.
Hakujärjestys on seuraava:
- Tietokantaan tallennettu Sivustoeditorin mukautus.
- Aktiivisen teeman alkuperäinen
.html-tiedosto. - Tiedostopohjainen Blockstudio-lähde.
- Emoteeman tai lisäosan varavaihtoehdot.
Tämä järjestys säilyttää Sivustoeditorin työnkulun. Kun käyttäjä muokkaa alatunnistetta ja tallentaa sen, WordPress tallentaa wp_template_part-artikkelin, ja get_block_template() palauttaa mukautuksen sekä arvon source: "custom". Myöhemmät muutokset tiedostoon parts/footer/index.html eivät näy mukautuksen ollessa olemassa. Kun käyttäjä palauttaa osan tai artikkeli poistetaan, haku siirtyy takaisin tiedostoon ja palauttaa uusimman käännetyn lähteen.
Blockstudio ei kirjoita Sivustoeditorin muutoksia takaisin tiedostoihin. Jos käyttäjän muutoksesta pitäisi tulla uusi oletus, kopioi se lähdetiedostoon ja palauta mukautus.
Sisäkkäiset index.html-kansiot ja etuliitteet
WordPress löytää rekursiivisesti .html-tiedostot hakemistoista templates/ ja parts/. Siksi manifestikansio, joka käyttää arvoa index.html, esimerkiksi parts/footer/index.html, näkyisi myös alkuperäisenä osana, jonka polusta johdettu etuliite on footer/index. Koska Blockstudio 7.6.6, manifestin omistama index.html näkyy vain sille määritetyllä etuliitteellä, joten Sivustoeditorissa näkyy yksi alatunniste kahden sijaan. Sisäkkäisiin .html-tiedostoihin ilman manifestia ei tehdä muutoksia.
Mallipohjien tarkistaminen PHP-toiminnolla
Blockstudio\Site_Templates-luokka lukee ja kääntää lähteet, mikä on hyödyllistä testeissä ja käyttöönoton tarkistuksissa:
$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();
Jokainen kohde sisältää arvot slug, title, description ja type (wp_template tai wp_template_part), status, source_type, mallipohjille postTypes tai osille area, meta sekä käännetyn arvon content. Välitä lista, jos haluat kääntää vain valitut kohteet. Lue kyseisen valinnan ongelmat arvolla selection_errors():
$selected = Blockstudio\Site_Templates::templates( array( 'front-page' ) );
$errors = Blockstudio\Site_Templates::selection_errors( 'templates' );
Muiden kansioiden lisääminen
Jos haluat pitää Blockstudio-lähteet erillään alkuperäisistä mallipohjista tai toimittaa ne lisäosan mukana, lisää hakupolkuja suodattimilla:
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;
} );
Suodattimet blockstudio/site_templates/template_content ja part_content muokkaavat lähdettä ennen sen jäsentämistä, ja blockstudio/site_templates/parser vaihtaa yhden kohteen jäsentimen. Täydellinen luettelo on kohdassa Sivustomallipohjien koukkutaulukko.
Milloin mitäkin kannattaa käyttää
| Tavoite | Käytä |
|---|---|
| Teeman asettelu WordPress, kun kyseessä on URL: ylätunniste, alatunniste, yksittäinen sisältö tai arkisto | Sivustomallipohjia ja osia |
| Reititettävä sivu, jonka sisältö on tiedostoissa | Tiedostopohjaiset sivut |
| Uudelleenkäytettävä osio, jonka editorit lisäävät | Kuviot |
Mallipohjat eivät luo artikkeleita. Sivut luovat. Esimerkiksi dokumentaation osio on sivukokoelma, jonka artikkelit hahmonnetaan mallipohjan kautta. Voit yhä luoda mallipohjan täällä.
Seuraavat vaiheet
- Sivustomallipohjien viite: kaikki manifestin ominaisuudet, PHP API ja kaikki koukut.
- Sivut ja kuviot -yleiskatsaus: mallipohjalähteissä käytettävä HTML-jäsennin, lohkotunnisteet ja elementtien määritys.
- Dokumentaatiosivuston rakentaminen: sivukokoelmat, joissa käytetään Markdown-arvoa, lataajia ja asetteluja.