Siirry sisältöön

Sivuston mallipohjat

Sivustomallit antavat lohkoteemojen määrittää WordPress wp_template– ja wp_template_part-lähteitä samalla tiedostolähtöisellä syntaksilla, jota käytetään Blockstudio-sivuissa ja kuvioissa.

Käytä sivustomallipohjia, kun haluat hallita teeman asettelua, jonka WordPress valitsee sivustoeditorin mallipohjahierarkiasta: etusivu, yksittäiset artikkelit, arkistot, haku, 404-sivut, ylä- ja alatunnisteet sekä muut mallipohjien osat.

Sivut, mallit vai sivustomallipohjat?

Ominaisuus Luo Sopii parhaiten
Sivut Artikkeleita tai mukautetun artikkelityypin kohteita Varsinaiset sisältösivut, dokumentaatiosivut, aloitussivut ja reititettävä sisältö.
Mallit Lohkomalleja Uudelleenkäytettäviä osioita, joita muokkaajat lisäävät.
Sivustomallipohjat wp_template– ja wp_template_part-tiedostolähteitä Teeman asettelu, jota hallitsevat sivustoeditori ja WordPress-mallipohjahierarkia.

Sivustomallipohjat eivät luo tavallisia sivuja. Ne tarjoavat tiedostolähteen, jota WordPress käyttää lohkoteeman mallipohjaa ratkaistessaan. Jos käyttäjä mukauttaa mallipohjaa sivustoeditorissa, WordPress tallentaa mukautuksen tietokantaan, ja se ohittaa tiedostolähteen, kunnes mukautus palautetaan.

Kansiorakenne

Sijoita täydet mallipohjat kohteeseen templates/ ja mallipohjien osat kohteeseen parts/:

Text
theme/
  templates/
    front-page/
      template.json
      index.php
    single/
      template.json
      index.twig
  parts/
    header/
      part.json
      index.php
    footer/
      part.json
      index.php

Jokaisessa kansiossa on manifesti ja yksi lähdetiedosto.

Tiedosto Käsittelymoottori
index.php HTML-tyyppistä lohkomerkintää, luetaan sellaisenaan (PHP-koodia ei suoriteta)
index.blade.php Blade
index.twig Twig
index.html HTML-tyyppistä lohkomerkintää

Jos lähdetiedostoja on useita, Blockstudio käyttää seuraavaa järjestystä:

  1. index.php
  2. index.blade.php
  3. index.twig
  4. index.html

WordPress löytää rekursiivisesti myös .html-tiedostoja ja paljastaa tavallisesti sisäkkäisen index.html-kohteen sen polusta johdetulla tunnuksella, kuten header/index. Kun tiedosto kuuluu Blockstudio-manifestiin, Blockstudio poistaa polusta johdetun kaksoiskappaleen ja paljastaa vain manifestissa määritetyn slug-kohteen. Sisäkkäiset natiivit .html-mallipohjat, joilla ei ole Blockstudio-manifestia, säilyvät ennallaan.

Lähde käännetään kerran natiiviksi WordPress-lohkomerkinnäksi. Sen ei pitäisi riippua nykyisestä pyynnöstä tai nykyisestä artikkelista. Sijoita suorituksenaikainen toiminta dynaamisiin lohkoihin.

template.json

template.json määrittää täyden sivustoeditorin mallipohjan.

JSON
{
  "slug": "front-page",
  "title": "Front Page",
  "description": "Homepage template",
  "postTypes": ["page"]
}

Ominaisuudet

Ominaisuus Tyyppi Oletusarvo Kuvaus
slug / name string Kansion nimi WordPress-mallipohjan tunnus. Käytä hierarkiassa täsmällisiä tunnuksia, kuten front-page, single, archive-product tai 404.
title string Tunnuksesta johdettu otsikko Näyttöotsikko sivustoeditorissa.
description string "" Sivustoeditorissa näytettävä kuvaus.
postTypes string[] [] Mukautettujen mallipohjien artikkelityypit. Core-hierarkian mallipohjat voivat jättää tämän pois.
source / template / file string Automaattisesti tunnistettu indeksitiedosto Valinnainen lähdetiedoston polku mallipohjakansioon nähden.
status string "publish" Mallipohjan tila.
sync boolean false Varattu tulevaa tietokantaan tallentamista varten. Käyttäjän mukautuksia ei koskaan korvata kohteessa v1.
meta object {} Aputoimintojen mukautetut metatiedot. Myös tuntemattomat manifestiavaimet tallennetaan tänne.

Mallipohjien tunnuksiin ei lisätä etuliitettä. WordPress tarvitsee mallipohjahierarkian tarkat nimet:

Text
index
home
front-page
single
single-post
single-product
archive
archive-product
page
page-about
404
search
taxonomy-product_cat

part.json

part.json määrittää sivustoeditorin mallipohjan osan.

JSON
{
  "slug": "header",
  "title": "Header",
  "description": "Main site header",
  "area": "header"
}

Ominaisuudet

Ominaisuus Tyyppi Oletusarvo Kuvaus
slug / name string Kansion nimi WordPress-mallipohjan osan tunnus.
title string Tunnuksesta johdettu otsikko Näyttöotsikko sivustoeditorissa.
description string "" Sivustoeditorissa näytettävä kuvaus.
area string "uncategorized" Mallipohjan osan alue. Tavallisia arvoja ovat header, footer ja sidebar.
source / template / file string Automaattisesti tunnistettu indeksitiedosto Valinnainen lähdetiedoston polku osakansioon nähden.
status string "publish" Mallipohjan osan tila.
meta object {} Aputoimintojen mukautetut metatiedot. Myös tuntemattomat manifestiavaimet tallennetaan tänne.

Merkintäkielen kirjoittaminen

Sivustomallipohjien lähteissä käytetään samaa jäsennintä kuin sivuissa ja malleissa:

PHP
<div class="site-shell">
  <block name="core/template-part" slug="header" />

  <main>
    <h1>Welcome</h1>
    <p>This template is compiled from Blockstudio files.</p>
    <block name="core/post-content" />
  </main>

  <block name="core/template-part" slug="footer" />
</div>

Elementistä <main> tulee core/group-lohko, joka näkyy muodossa <main>, ja sen lapsista, mukaan lukien core/post-content-lohkon tunnisteesta, tulee sisälohkoja. Voit käyttää seuraavia:

  • tavallisia HTML-elementtejä, kuten <h1>, <p>, <ul>, <div> sekä osiointielementtejä <main>, <header>, <footer>, <article> ja <aside>
  • <block name="namespace/block">
  • <bs:namespace-block>
  • määritettyjä lohkotunnisteiden etuliitteitä
  • Blockstudio-lohkoja ja komponentteja

Mallipohjan osalohkot saavat aktiivisen teeman attribuutin, kun WordPress renderöi käännetyn mallipohjan.

Sivustoeditorin mukautukset

Blockstudio tarjoaa tiedostolähteen. WordPress hallitsee käyttäjän mukautuksia.

Hakujärjestys on seuraava:

  1. Sivustoeditorin tietokantaan tallennettu mukautus
  2. Aktiivisen teeman natiivi .html-tiedosto
  3. Blockstudio-tiedostolähde
  4. Yläteeman tai lisäosan varavaihtoehdot

Kun käyttäjä tallentaa Blockstudio-tiedostopohjaisen mallipohjan sivustoeditorissa, WordPress luo tavallisen wp_template– tai wp_template_part-tietokantamerkinnän. Tallennettu merkintä ohittaa myöhemmät tiedostomuutokset. Mukautuksen palauttaminen tai poistaminen tuo uusimman tiedostopohjaisen lähteen jälleen näkyviin.

Blockstudio ei kirjoita sivustoeditorin muokkauksia takaisin tiedostoihin kohteessa v1.

Suorituskyky

Mallipohjien etsintä tallennetaan välimuistiin pyynnön ajaksi ja pysyvästi tiedostojen tarkkailun metatietojen kanssa. Manifestin tai lähdetiedoston muuttaminen mitätöi käännetyn sisällön välimuistin. Tietokantaan tallennettuja mukautuksia ei tallenneta välimuistiin: WordPress tarkistaa ne aina ensin.

Suorituksenaikaiset integraatiot, jotka kokoavat tiedostoja useista juurihakemistoista, voivat tarjota mallipohjille ja niiden osille loogisen etsintälähteen. Manifestit ja valitut lähdemallipohjat voivat olla eri fyysisissä juurihakemistoissa, mutta ne muodostavat silti yhden loogisen teemapuun.

PHP API

PHP
$templates = Blockstudio\Site_Templates::templates();
$parts = Blockstudio\Site_Templates::parts();

$template = Blockstudio\Site_Templates::get_template('front-page');
$header = Blockstudio\Site_Templates::get_part('header');

$paths = Blockstudio\Site_Templates::get_paths();

Välitä nimenomainen luettelo, jotta vain tarkat tunnukset, polut tai lähdepolut luetaan ja käännetään:

PHP
$templates = Blockstudio\Site_Templates::templates([
    'front-page',
]);

$parts = Blockstudio\Site_Templates::parts([
    'header',
]);

$errors = Blockstudio\Site_Templates::selection_errors('templates');

Argumentin pois jättäminen säilyttää rekisterin koko toiminnan. Tyhjän luettelon välittäminen palauttaa tyhjän tuloksen. Tavanomaiset tunnus- ja polkupyynnöt rajaavat etsinnän vastaaviin hakemistoihin; mukautetut manifestitunnukset voivat edellyttää metatietojen skannausta, mutta muita lähteitä ei silti käännetä eikä palauteta.

Käytettävissä on myös mallipohjien aputoimintoja:

PHP
blockstudio_site_templates();
blockstudio_site_template_parts();
blockstudio_site_template('front-page');
blockstudio_site_template_part('header');

Hookit

Sivustomallipohjien koko laajennuspinta on seuraava:

Koukkukohta Tyyppi Kuvaus
blockstudio/site_templates/template_paths Suodatin Muokkaa kokonaisten mallipohjien etsintäjuurihakemistoja.
blockstudio/site_templates/part_paths Suodatin Muokkaa mallipohjan osien etsintäjuurihakemistoja.
blockstudio/site_templates/paths Suodatin Muokkaa molempia polkuluetteloita muodossa templates ja parts.
blockstudio/site_templates/template_candidates Suodatin Muokkaa manifestin lähdetiedostoehdokkaita.
blockstudio/site_templates/templates Suodatin Muokkaa rekisterin palauttamia mallipohjia kohdassa API.
blockstudio/site_templates/parts Suodatin Muokkaa rekisterin palauttamia mallipohjan osia kohdassa API.
blockstudio/site_templates/template_content Suodatin Muokkaa käännettyä kokonaista mallipohjalähdettä ennen jäsentämistä.
blockstudio/site_templates/part_content Suodatin Muokkaa käännettyä mallipohjan osan lähdettä ennen jäsentämistä.
blockstudio/site_templates/parser Suodatin Korvaa Html_Parser-instanssi yksittäiselle kohteelle.
blockstudio/site_templates/source_compiled Toiminto Suoritetaan juuri ennen valitun lähteen kääntämistä.
blockstudio/site_templates/discovered Toiminto Suoritetaan kylmän etsintä- ja käännöskierroksen jälkeen.
blockstudio/site_templates/registered Toiminto Suoritetaan, kun uudelleen rakennettu rekisteri on tallennettu pysyvästi.

Lisää etsintäpolkuja tai korvaa ne:

PHP
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;
});

add_filter('blockstudio/site_templates/paths', function ($paths) {
    return $paths;
});

Suodata löydetyt tiedot:

PHP
add_filter('blockstudio/site_templates/templates', function ($templates) {
    return $templates;
});

add_filter('blockstudio/site_templates/parts', function ($parts) {
    return $parts;
});

Suodata lähde ennen jäsentämistä:

PHP
add_filter('blockstudio/site_templates/template_content', function ($content, $template) {
    return $content;
}, 10, 2);

add_filter('blockstudio/site_templates/part_content', function ($content, $part) {
    return $content;
}, 10, 2);

Muuta lähdetiedostoehdokkaita tai jäsennintä:

PHP
add_filter(
    'blockstudio/site_templates/template_candidates',
    function ($candidates, $directory, $manifest) {
        $candidates[] = $directory . '/template.custom.php';
        return $candidates;
    },
    10,
    3
);

add_filter(
    'blockstudio/site_templates/parser',
    function ($parser, $item) {
        return $parser;
    },
    10,
    2
);

discovered ja registered ovat välimuistin uudelleenrakennuksen elinkaaritoimintoja. Niitä ei suoriteta, kun rekisterin lämmin välimuistiosuma löytyy.