Pereiti prie turinio

Svetainės šablonai

Svetainės šablonai leidžia blokų temoms apibrėžti WordPress wp_template ir wp_template_part šaltinius, naudojant tą pačią pirmiausia failais pagrįstą sintaksę kaip Blockstudio puslapiams ir šablonams.

Naudokite svetainės šablonus, kai norite valdyti temos maketą, kurį WordPress parenka pagal Svetainės redaktoriaus šablonų hierarchiją: pradžios puslapiui, pavieniams įrašams, archyvams, paieškai, 404 puslapiams, antraštėms, poraštėms ir kitoms šablonų dalims.

Puslapiai, šablonai ar svetainės šablonai?

Funkcija Sukuriama Geriausiai tinka
Puslapiai Įrašai arba tinkinto įrašo tipo elementai Tikri turinio puslapiai, dokumentacijos puslapiai, nukreipimo puslapiai ir maršrutu pasiekiamas turinys.
Šablonai Blokų šablonai Pakartotinai naudojami skyriai, kuriuos įterpia redaktoriai.
Svetainės šablonai wp_template ir wp_template_part failų šaltiniai Temos maketas, valdomas Svetainės redaktoriaus ir WordPress šablonų hierarchijos.

Svetainės šablonai nesukuria įprastų puslapių. Jie pateikia failo šaltinį, kurį WordPress naudoja nustatydamas blokų temos šabloną. Jei naudotojas tinkina šabloną Svetainės redaktoriuje, WordPress išsaugo tinkinimą duomenų bazėje, ir jis turi pirmenybę prieš failo šaltinį, kol tinkinimas neatkuriamas.

Aplankų struktūra

Visus šablonus dėkite į templates/, o šablonų dalis – į 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

Kiekviename aplanke yra manifestas ir vienas šaltinio failas.

Failas Variklis
index.php HTML tipo blokų žymėjimas, skaitomas toks, koks yra (PHP kodas nevykdomas)
index.blade.php Blade
index.twig Twig
index.html HTML tipo blokų žymėjimas

Jei yra keli šaltinio failai, Blockstudio juos tikrina šia tvarka:

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

WordPress taip pat rekursyviai aptinka .html failus ir paprastai atskleidžia įdėtą index.html pagal iš kelio sudarytą žymą, pavyzdžiui, header/index. Jei tas failas priklauso Blockstudio manifestui, Blockstudio pašalina iš kelio sudarytą dublikatą ir atskleidžia tik manifeste nurodytą slug. Įdėti savieji .html šablonai be Blockstudio manifesto nekeičiami.

Šaltinis vieną kartą sukompiliuojamas į savąjį WordPress blokų žymėjimą. Jis neturėtų priklausyti nuo dabartinės užklausos ar įrašo. Vykdymo metu atliekamą logiką įdėkite į dinaminius blokus.

template.json

template.json apibrėžia visą Svetainės redaktoriaus šabloną.

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

Savybės

Savybė Tipas Numatytoji reikšmė Aprašymas
slug / name string Aplanko pavadinimas WordPress šablono žyma. Naudokite tikslias hierarchijos žymas, pavyzdžiui, front-page, single, archive-product arba 404.
title string Pavadinimas iš žymos Rodomas pavadinimas Svetainės redaktoriuje.
description string "" Rodomas aprašymas Svetainės redaktoriuje.
postTypes string[] [] Tinkintų šablonų įrašų tipai. Branduolio hierarchijos šablonuose šį lauką galima praleisti.
source / template / file string Automatiškai aptinkamas indekso failas Pasirinktinis šaltinio failo kelias šablono aplanko atžvilgiu.
status string "publish" Šablono būsena.
sync boolean false Skirta būsimiems duomenų bazės materializavimo atvejams. Naudotojo tinkinimai v1 niekada neperrašomi.
meta object {} Pagalbinėms API skirtieji tinkinti metaduomenys. Čia taip pat saugomi nežinomi manifesto raktai.

Šablonų žymos neturi prefikso. WordPress šablonų hierarchijai reikia tikslių pavadinimų:

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 apibrėžia Svetainės redaktoriaus šablono dalį.

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

Savybės

Savybė Tipas Numatytoji reikšmė Aprašymas
slug / name string Aplanko pavadinimas WordPress šablono dalies žyma.
title string Pavadinimas iš žymos Rodomas pavadinimas Svetainės redaktoriuje.
description string "" Rodomas aprašymas Svetainės redaktoriuje.
area string "uncategorized" Šablono dalies sritis. Dažniausios reikšmės: header, footer ir sidebar.
source / template / file string Automatiškai aptinkamas indekso failas Pasirinktinis šaltinio failo kelias dalies aplanko atžvilgiu.
status string "publish" Šablono dalies būsena.
meta object {} Pagalbinėms API skirti tinkinti metaduomenys. Čia taip pat saugomi nežinomi manifesto raktai.

Žymėjimo kūrimas

Svetainės šablonų šaltiniuose naudojamas tas pats analizatorius kaip puslapiuose ir šablonuose:

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>

Elementas <main> tampa bloku core/group, kuris atvaizduojamas kaip <main>, o jo vaikiniai elementai, įskaitant bloko žymą core/post-content, tampa vidiniais blokais. Galite naudoti:

  • standartinius HTML elementus, tokius kaip <h1>, <p>, <ul>, <div> ir skirsnius žyminčius elementus <main>, <header>, <footer>, <article> ir <aside>
  • <block name="namespace/block">
  • <bs:namespace-block>
  • sukonfigūruotus blokų žymų prefiksus
  • Blockstudio blokus ir komponentus

Šablono dalies blokams priskiriamas aktyvios temos atributas, kai WordPress atvaizduoja sukompiliuotą šabloną.

Svetainės redaktoriaus tinkinimai

Blockstudio pateikia failo šaltinį. WordPress valdo naudotojo tinkinimus.

Paieškos tvarka:

  1. Svetainės redaktoriaus tinkinimas duomenų bazėje
  2. aktyvios savosios temos failas .html
  3. failais pagrįstas Blockstudio šaltinis
  4. atsarginiai šaltiniai iš pagrindinės temos arba įskiepių

Kai naudotojas Svetainės redaktoriuje išsaugo failais pagrįstą šabloną Blockstudio, WordPress sukuria įprastą duomenų bazės įrašą wp_template arba wp_template_part. Šis išsaugotas įrašas turi pirmenybę prieš būsimus failų pakeitimus. Atkūrus arba ištrynus tinkinimą, vėl rodomas naujausias failais pagrįstas šaltinis.

Blockstudio neįrašo Svetainės redaktoriaus pakeitimų į failus, esančius v1.

Našumas

Šablonų aptikimo rezultatai kaupiami podėlyje pagal užklausą ir išsaugomi kartu su failų stebėjimo metaduomenimis. Pakeitus manifestą ar šaltinio failą, podėlyje esantis sukompiliuotas turinys tampa nebegaliojantis. Duomenų bazės tinkinimai nepatenka į podėlį: WordPress vis tiek pirmiausia tikrina juos.

Vykdymo metu failus iš kelių šakninių katalogų sujungiančios integracijos gali pateikti šablonų ir jų dalių loginį aptikimo šaltinį. Manifestai ir pasirinkti šaltinio šablonai gali būti skirtinguose fiziniuose šakniniuose kataloguose, tačiau sudaryti vieną loginį temos medį.

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

Perduokite aiškų sąrašą, kad būtų skaitomos ir kompiliuojamos tik tikslios žymos, keliai arba šaltinio keliai:

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

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

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

Praleidus argumentą išlaikoma visa registro elgsena. Perdavus tuščią sąrašą, negrąžinamas nė vienas elementas. Įprastomis žymomis ir keliais pagrįstos užklausos apriboja aptikimą atitinkamais katalogais; tinkintoms manifesto žymoms gali prireikti metaduomenų skenavimo, tačiau nesusiję šaltiniai vis tiek nekompiliuojami ir negrąžinami.

Taip pat prieinamos šablonų pagalbinės funkcijos:

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

Kabliukai

Visas Svetainės šablonų plėtimo funkcijas sudaro:

Įskiepio funkcija Tipas Aprašymas
blockstudio/site_templates/template_paths Filtras Koreguoja visų šablonų aptikimo šakninius katalogus.
blockstudio/site_templates/part_paths Filtras Koreguoja šablonų dalių aptikimo šakninius katalogus.
blockstudio/site_templates/paths Filtras Koreguoja abu kelių sąrašus kaip templates ir parts.
blockstudio/site_templates/template_candidates Filtras Koreguoja manifeste nurodyto šaltinio failų kandidatus.
blockstudio/site_templates/templates Filtras Koreguoja registro API grąžinamus šablonus.
blockstudio/site_templates/parts Filtras Koreguoja registro API grąžinamas šablonų dalis.
blockstudio/site_templates/template_content Filtras Koreguoja sukompiliuotą viso šablono šaltinį prieš analizavimą.
blockstudio/site_templates/part_content Filtras Koreguoja sukompiliuotą šablono dalies šaltinį prieš analizavimą.
blockstudio/site_templates/parser Filtras Pakeičia elemento egzempliorių Html_Parser.
blockstudio/site_templates/source_compiled Veiksmas Vykdomas prieš pat kompiliuojant vieną pasirinktą šaltinį.
blockstudio/site_templates/discovered Veiksmas Vykdomas po šalto aptikimo ir kompiliavimo ciklo.
blockstudio/site_templates/registered Veiksmas Vykdomas išsaugojus atkurtą registrą.

Pridėkite arba pakeiskite aptikimo kelius:

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

Filtruokite aptiktus duomenis:

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

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

Filtruokite šaltinį prieš analizavimą:

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

Keiskite šaltinio failų kandidatus arba analizatorių:

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 ir registered yra podėlio atkūrimo ciklo veiksmai. Jie nevykdomi, kai panaudojamas šiltas registro podėlis.