Liigu sisu juurde

Saidi mallid

Saidi mallid võimaldavad plokiteemadel määratleda WordPress wp_template ja wp_template_part allikaid, kasutades sama failipõhist süntaksit nagu Blockstudio lehtede ja mustrite puhul.

Kasuta saidimalle siis, kui soovid juhtida teema paigutust, mille WordPress valib saidiredaktori mallihierarhia kaudu: avaleht, üksikpostitused, arhiivid, otsing, 404 lehed, päised, jalused ja muud malliosad.

Lehed, mustrid või saidi mallid?

Funktsioon Loob Sobib kõige paremini
Lehed Postitused või kohandatud sisupostituse tüübi kirjed Päris sisulehed, dokumentatsiooni lehed, sihtlehed ja marsruuditav sisu.
Mustrid Plokimustrid Korduvkasutatavad jaotised, mille toimetajad lisavad.
Saidi mallid wp_template ja wp_template_part failiallikad Teema paigutus, mida juhivad saidiredaktor ja WordPress mallihierarhia.

Saidi mallid ei loo tavalisi lehti. Need pakuvad failiallika, mida WordPress kasutab plokiteema malli leidmisel. Kui kasutaja kohandab malli saidiredaktoris, salvestab WordPress selle kohanduse andmebaasi ning see jääb failiallikast eelisjärjekorda, kuni kohandus lähtestatakse.

Kaustastruktuur

Paiguta täismallid kausta templates/ ja malliosad kausta 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

Igal kaustal on manifest ja üks lähtefail.

Fail Mootor
index.php HTML-laadne ploki märgendus, loetakse muutmata kujul (PHP koodi ei käivitata)
index.blade.php Blade
index.twig Twig
index.html HTML-laadne ploki märgendus

Kui lähtefaile on mitu, kasutab Blockstudio järgmist järjestust:

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

WordPress leiab rekursiivselt ka faile .html ning näitab tavaliselt pesastatud index.html üksust tuletatud tee nimega, näiteks header/index. Kui see fail kuulub Blockstudio manifesti juurde, eemaldab Blockstudio teetuletusega duplikaadi ja näitab ainult manifestis määratletud slug üksust. Pesastatud natiivsed .html mallid, millel pole Blockstudio manifesti, jäävad muutmata.

Lähtefail kompileeritakse üks kord natiivseks WordPress ploki märgenduseks. See ei tohiks sõltuda käesolevast päringust ega postitusest. Paiguta käitusaegne käitumine dünaamilistesse plokkidesse.

template.json

template.json määratleb täieliku saidiredaktori malli.

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

Omadused

Omadus Tüüp Vaikeväärtus Kirjeldus
slug / name string Kausta nimi WordPress malli tunnus. Kasuta mallihierarhia täpseid tunnuseid, näiteks front-page, single, archive-product või 404.
title string Pealkiri tunnusest Kuvatav pealkiri saidiredaktoris.
description string "" Kuvatav kirjeldus saidiredaktoris.
postTypes string[] [] Kohandatud mallide sisupostituse tüübid. Tuumhierarhia mallidel võib selle välja ära jätta.
source / template / file string Automaatselt tuvastatud registrifail Valikuline lähtefaili tee mallikausta suhtes.
status string "publish" Malli olek.
sync boolean false Reserveeritud tulevaseks andmebaasi teisendamiseks. Kasutaja kohandusi ei kirjutata kunagi üle asukohas v1.
meta object {} Abiliideste kohandatud metaandmed. Tundmatud manifesti võtmed salvestatakse samuti siia.

Malli tunnustele eesliidet ei lisata. WordPress vajab mallihierarhia jaoks täpseid nimesid:

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ääratleb saidiredaktori malliosa.

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

Omadused

Omadus Tüüp Vaikeväärtus Kirjeldus
slug / name string Kausta nimi WordPress malli osa tunnus.
title string Pealkiri tunnusest Kuvatav pealkiri saidiredaktoris.
description string "" Kuvatav kirjeldus saidiredaktoris.
area string "uncategorized" Malliosa ala. Levinud väärtused on header, footer ja sidebar.
source / template / file string Automaatselt tuvastatud registrifail Valikuline lähtefaili tee malli osa kausta suhtes.
status string "publish" Malliosa olek.
meta object {} Abiliideste kohandatud metaandmed. Tundmatud manifesti võtmed salvestatakse samuti siia.

Märgenduse kirjutamine

Saidi mallide lähtefailid kasutavad sama parserit nagu lehed ja mustrid:

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>

Element <main> muutub plokiks core/group, mis renderdub kujul <main>, ning selle alamelemendid, sealhulgas plokisilt core/post-content, muutuvad selle sisemisteks plokkideks. Võid kasutada järgmist:

  • standardseid HTML elemente, näiteks <h1>, <p>, <ul>, <div>, ning sektsioone määratlevaid elemente <main>, <header>, <footer>, <article> ja <aside>
  • <block name="namespace/block">
  • <bs:namespace-block>
  • seadistatud plokisiltide eesliiteid
  • Blockstudio plokke ja komponente

Malliosa plokid saavad aktiivse teema atribuudi, kui WordPress kompileeritud malli renderdab.

Saidiredaktori kohandused

Blockstudio pakub failiallika. Kasutaja kohandusi haldab WordPress.

Otsingujärjestus on järgmine:

  1. Saidiredaktori andmebaasikohandus
  2. aktiivse teema natiivne fail .html
  3. Blockstudio failipõhine allikas
  4. emateema või plugina varuvariandid

Kui kasutaja salvestab saidiredaktoris Blockstudio failipõhise malli, loob WordPress andmebaasi tavalise kirje wp_template või wp_template_part kujul. See salvestatud kirje jääb tulevaste failimuudatuste suhtes eelisjärjekorda. Kohanduse lähtestamisel või kustutamisel ilmub taas uusim failipõhine allikas.

Blockstudio ei kirjuta saidiredaktori muudatusi tagasi failidesse asukohas v1.

Jõudlus

Mallide tuvastamist puhverdatakse päringu kaupa ning puhver salvestatakse koos failide jälgimise metaandmetega. Manifesti või lähtefaili muutmine muudab kompileeritud sisu vahemälu kehtetuks. Andmebaasi kohandusi ei puhverdada: WordPress kontrollib neid endiselt esimesena.

Mitmest juurkataloogist faile koondavad käitusaegsed integratsioonid võivad anda mallide ja malliosade jaoks loogilise tuvastusallika. Manifestid ja valitud lähtemallid võivad asuda eri füüsilistes juurkataloogides, kuid moodustada siiski ühe loogilise teemapuu.

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();

Edasta selgesõnaline loend, et lugeda ja kompileerida ainult täpsed tunnused, teed või lähtefailide teed:

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

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

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

Argumendi väljajätmisel säilib registri täielik käitumine. Tühja loendi edastamisel ei tagastata ühtegi üksust. Tavapärase tunnuse või tee päring piirab tuvastamise vastavate kataloogidega; kohandatud manifesti tunnused võivad nõuda metaandmete skannimist, kuid sõltumatuid lähtefaile siiski ei kompileerita ega tagastata.

Saadaval on ka malli abifunktsioonid:

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

Hook’id

Saidi mallide laienduspunkte on kokku järgmised:

Konks Tüüp Kirjeldus
blockstudio/site_templates/template_paths Filter Muuda täismallide tuvastamise juurkatalooge.
blockstudio/site_templates/part_paths Filter Muuda malliosade tuvastamise juurkatalooge.
blockstudio/site_templates/paths Filter Muuda mõlemat teeloendit kujul templates ja parts.
blockstudio/site_templates/template_candidates Filter Muuda manifesti lähtefailide kandidaate.
blockstudio/site_templates/templates Filter Muuda registri tagastatavaid malle API.
blockstudio/site_templates/parts Filter Muuda registri tagastatavaid malliosi API.
blockstudio/site_templates/template_content Filter Muuda kompileeritud täismalli allikat enne parsimist.
blockstudio/site_templates/part_content Filter Muuda kompileeritud malli osa allikat enne parsimist.
blockstudio/site_templates/parser Filter Asenda ühe üksuse Html_Parser eksemplar.
blockstudio/site_templates/source_compiled Toiming Käivitatakse vahetult enne valitud allika kompileerimist.
blockstudio/site_templates/discovered Toiming Käivitatakse pärast külma tuvastus- ja kompileerimisprotsessi.
blockstudio/site_templates/registered Toiming Käivitatakse pärast taastatud registri salvestamist.

Lisa või asenda tuvastamisteid:

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

Filtreeri tuvastatud andmeid:

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

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

Filtreeri allikat enne parsimist:

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

Muuda allikakandidaate või parserit:

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 on vahemälu taastamise elutsükli toimingud. Need ei käivitu registri soojast vahemälust pärimise korral.