Preskoči na vsebino

Predloge spletnega mesta

Predloge spletnega mesta omogočajo blokovnim temam, da z isto sintakso, ki temelji na datotekah in jo uporabljajo strani in vzorci Blockstudio, določijo vire WordPress wp_template in wp_template_part.

Predloge spletnega mesta uporabite, kadar želite nadzorovati postavitev teme, ki jo WordPress izbere prek hierarhije predlog urejevalnika spletnega mesta: domača stran, posamezne objave, arhivi, iskanje, strani 404, glave, noge in drugi deli predlog.

Strani, vzorci ali predloge spletnega mesta?

Funkcija Ustvari Najbolj primerno za
Strani Objave ali vnose vrste objave po meri Dejanske vsebinske strani, strani dokumentacije, pristajalne strani in vsebino z lastno potjo.
Vzorci Vzorci blokov Ponovno uporabne razdelke, ki jih vstavijo uredniki.
Predloge spletnega mesta Vire datotek wp_template in wp_template_part Postavitev teme, ki jo nadzira urejevalnik spletnega mesta, in hierarhija predlog WordPress.

Predloge spletnega mesta ne ustvarijo običajnih strani. Zagotavljajo vir datoteke, ki ga WordPress uporabi pri razreševanju predloge blokovne teme. Če uporabnik prilagodi predlogo v urejevalniku spletnega mesta, WordPress to prilagoditev shrani v zbirko podatkov, kjer ima prednost pred virom datoteke, dokler je ne ponastavite.

Struktura map

Polne predloge shranite v templates/, dele predlog pa v 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

Vsaka mapa vsebuje manifest in eno izvorno datoteko.

Datoteka Mehanizem
index.php Oznaka bloka, podobna HTML, prebrana nespremenjena (koda PHP se ne izvede)
index.blade.php Blade
index.twig Twig
index.html Oznaka bloka, podobna HTML

Če obstaja več izvornih datotek, jih Blockstudio uporabi v tem vrstnem redu:

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

WordPress tudi rekurzivno odkrije datoteke .html in običajno izpostavi vgnezdeno index.html pod imenom, izpeljanim iz njene poti, na primer header/index. Ko ta datoteka pripada manifestu Blockstudio, Blockstudio odstrani podvojeni vnos, izpeljan iz poti, in izpostavi le slug, ki ga določa manifest. Vgnezdene izvorne predloge .html brez manifesta Blockstudio ostanejo nespremenjene.

Vir se enkrat prevede v izvorno oznako bloka WordPress. Ne sme biti odvisen od trenutne zahteve ali objave. Obnašanje med izvajanjem vključite v dinamične bloke.

template.json

template.json določa polno predlogo urejevalnika spletnega mesta.

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

Lastnosti

Lastnost Vrsta Privzeto Opis
slug / name string Ime mape Slug predloge WordPress. Uporabite natančne sluge hierarhije, kot so front-page, single, archive-product ali 404.
title string Naslov iz sluga Prikazni naslov v urejevalniku spletnega mesta.
description string "" Prikazni opis v urejevalniku spletnega mesta.
postTypes string[] [] Vrste objav za predloge po meri. Pri predlogah osnovne hierarhije to polje ni obvezno.
source / template / file string Samodejno zaznana indeksna datoteka Izbirna pot do izvorne datoteke glede na mapo predloge.
status string "publish" Stanje predloge.
sync boolean false Rezervirano za prihodnjo materializacijo v zbirki podatkov. Prilagoditve uporabnikov v v1 se nikoli ne prepišejo.
meta object {} Metapodatki po meri za pomožne API-je. Neznani ključi manifesta se shranijo tudi sem.

Slugi predlog nimajo predpone. WordPress potrebuje natančna imena za hierarhijo predlog:

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 določa del predloge urejevalnika spletnega mesta.

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

Lastnosti

Lastnost Vrsta Privzeto Opis
slug / name string Ime mape Slug dela predloge WordPress.
title string Naslov iz sluga Prikazni naslov v urejevalniku spletnega mesta.
description string "" Prikazni opis v urejevalniku spletnega mesta.
area string "uncategorized" Območje dela predloge. Pogoste vrednosti so header, footer in sidebar.
source / template / file string Samodejno zaznana indeksna datoteka Izbirna pot do izvorne datoteke glede na mapo dela predloge.
status string "publish" Stanje dela predloge.
meta object {} Metapodatki po meri za pomožne API-je. Neznani ključi manifesta se shranijo tudi sem.

Pisanje oznake

Viri predlog spletnega mesta uporabljajo isti razčlenjevalnik kot strani in vzorci:

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> postane blok core/group, ki se izriše kot <main>, njegovi podrejeni elementi, vključno z oznako bloka core/post-content, pa postanejo njegovi notranji bloki. Uporabite lahko:

  • standardne elemente HTML, kot so <h1>, <p>, <ul>, <div>, ter elemente za razdelitev vsebine na odseke: <main>, <header>, <footer>, <article> in <aside>
  • <block name="namespace/block">
  • <bs:namespace-block>
  • konfigurirane predpone oznak blokov
  • Blockstudio bloke in komponente

Bloki delov predloge prejmejo atribut aktivne teme, ko WordPress izriše prevedeno predlogo.

Prilagoditve v urejevalniku spletnega mesta

Blockstudio zagotavlja vir datoteke. WordPress upravlja uporabniške prilagoditve.

Vrstni red iskanja je:

  1. Prilagoditev v zbirki podatkov urejevalnika spletnega mesta
  2. Izvorna datoteka .html aktivne teme
  3. Vir iz datoteke Blockstudio
  4. Rezervni viri nadrejene teme ali vtičnika

Ko uporabnik shrani predlogo iz datoteke Blockstudio v urejevalniku spletnega mesta, WordPress ustvari običajen vnos zbirke podatkov wp_template ali wp_template_part. Ta shranjeni vnos ima prednost pred prihodnjimi spremembami datoteke. Če prilagoditev ponastavite ali izbrišete, se znova prikaže najnovejši vir iz datoteke.

Blockstudio sprememb v urejevalniku spletnega mesta ne zapisuje nazaj v datoteke v v1.

Zmogljivost

Odkrivanje predlog se predpomni za posamezno zahtevo, podatki o spremljanju datotek pa se shranijo. Sprememba manifesta ali izvorne datoteke razveljavi predpomnjeno prevedeno vsebino. Prilagoditve v zbirki podatkov se ne predpomnijo: WordPress jih še vedno preveri najprej.

Integracije med izvajanjem, ki sestavljajo datoteke iz več korenskih map, lahko predložijo logični vir odkrivanja za predloge in dele predlog. Manifesti in izbrane izvorne predloge so lahko v različnih fizičnih korenskih mapah, hkrati pa ohranijo eno logično drevo teme.

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

Posredujte izrecen seznam, da preberete in prevedete samo natančne sluge, poti ali izvorne poti:

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

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

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

Če argument izpustite, se ohrani celotno delovanje registra. Prazen seznam ne vrne nobenega elementa. Zahteve z običajnimi slugi in potmi omejijo odkrivanje na ustrezne imenike; slugi po meri iz manifesta lahko zahtevajo pregled metapodatkov, vendar se nepovezani viri vseeno ne prevedejo in ne vrnejo.

Na voljo so tudi pomožne funkcije za predloge:

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

Kavlji

Celoten nabor razširitvenih možnosti Site Templates:

Zanka Vrsta Opis
blockstudio/site_templates/template_paths Filter Prilagodi korenske mape za odkrivanje polnih predlog.
blockstudio/site_templates/part_paths Filter Prilagodi korenske mape za odkrivanje delov predlog.
blockstudio/site_templates/paths Filter Prilagodi oba seznama poti kot templates in parts.
blockstudio/site_templates/template_candidates Filter Prilagodi kandidate za izvorne datoteke manifesta.
blockstudio/site_templates/templates Filter Prilagodi predloge, ki jih vrne register API.
blockstudio/site_templates/parts Filter Prilagodi dele predlog, ki jih vrne register API.
blockstudio/site_templates/template_content Filter Prilagodi prevedeni vir polne predloge pred razčlenjevanjem.
blockstudio/site_templates/part_content Filter Prilagodi prevedeni vir dela predloge pred razčlenjevanjem.
blockstudio/site_templates/parser Filter Zamenja primerek Html_Parser za en element.
blockstudio/site_templates/source_compiled Dejanje Se izvede tik pred prevajanjem enega izbranega vira.
blockstudio/site_templates/discovered Dejanje Se izvede po hladnem prehodu odkrivanja in prevajanja.
blockstudio/site_templates/registered Dejanje Se izvede po shranjevanju obnovljenega registra.

Dodajte ali zamenjajte poti za odkrivanje:

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

Filtrirajte odkrite podatke:

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

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

Filtrirajte vir pred razčlenjevanjem:

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

Spremenite kandidate vira ali razčlenjevalnik:

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 in registered sta dejanji življenjskega cikla za obnovo predpomnilnika. Ob zadetku v toplem predpomnilniku registra se ne sprožita.