Preskočiť na obsah

Šablóny webu

Šablóny webu umožňujú témam blokov definovať zdroje WordPress wp_template a wp_template_part s rovnakou syntaxou založenou na súboroch, akú používajú stránky a vzory Blockstudio.

Šablóny webu použite, keď chcete ovládať rozloženie témy, ktoré WordPress vyberá podľa hierarchie šablón editora webu: úvodná stránka, jednotlivé príspevky, archívy, vyhľadávanie, stránky 404, hlavičky, päty a ďalšie časti šablón.

Stránky, vzory alebo šablóny webu?

Funkcia Vytvára Najvhodnejšie na
Stránky Príspevky alebo záznamy vlastného typu príspevku Skutočné obsahové stránky, stránky dokumentácie, vstupné stránky a obsah prístupný cez smerovanie.
Vzory Vzory blokov Opakovane použiteľné sekcie, ktoré vkladajú editori.
Šablóny webu Zdroje súborov wp_template a wp_template_part Rozloženie témy riadené editorom webu a hierarchiou šablón WordPress.

Šablóny webu nevytvárajú bežné stránky. Poskytujú zdroj súborov, ktorý WordPress používa pri vyhľadávaní šablóny témy blokov. Ak používateľ prispôsobí šablónu v editore webu, WordPress uloží tieto úpravy do databázy a majú prednosť pred zdrojom súborov, kým sa neobnoví pôvodný stav.

Štruktúra priečinkov

Úplné šablóny umiestnite do templates/ a časti šablón do 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

Každý priečinok obsahuje manifest a jeden zdrojový súbor.

Súbor Nástroj
index.php Označenie blokov podobné HTML, číta sa tak, ako je (kód PHP sa nespúšťa)
index.blade.php Blade
index.twig Twig
index.html Označenie blokov podobné HTML

Ak existuje viacero zdrojových súborov, Blockstudio použije toto poradie:

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

WordPress tiež rekurzívne vyhľadáva súbory .html a zvyčajne sprístupní vnorenú položku index.html pod názvom odvodeným z jej cesty, napríklad header/index. Keď tento súbor patrí k manifestu Blockstudio, Blockstudio odstráni duplicitnú položku odvodenú z cesty a sprístupní iba položku slug deklarovanú v manifeste. Vnorené natívne šablóny .html bez manifestu Blockstudio zostanú nezmenené.

Zdroj sa raz skompiluje do natívneho označenia blokov WordPress. Nemal by závisieť od aktuálnej požiadavky ani príspevku. Správanie za behu umiestnite do dynamických blokov.

template.json

template.json definuje úplnú šablónu editora webu.

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

Vlastnosti

Vlastnosť Typ Predvolená hodnota Popis
slug / name string Názov priečinka Názov šablóny WordPress. Použite presné názvy hierarchie, napríklad front-page, single, archive-product alebo 404.
title string Názov odvodený od názvu Zobrazovaný názov v editore webu.
description string "" Zobrazovaný popis v editore webu.
postTypes string[] [] Typy príspevkov pre vlastné šablóny. Pri šablónach základnej hierarchie možno túto vlastnosť vynechať.
source / template / file string Automaticky zistený indexový súbor Voliteľná cesta k zdrojovému súboru vzhľadom na priečinok šablóny.
status string "publish" Stav šablóny.
sync boolean false Vyhradené na budúce ukladanie do databázy. Používateľské úpravy v v1 sa nikdy neprepíšu.
meta object {} Vlastné metadáta pre pomocné API. Ukladajú sa sem aj neznáme kľúče manifestu.

Názvy šablón nemajú predponu. WordPress potrebuje presné názvy pre hierarchiu šablón:

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 definuje časť šablóny editora webu.

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

Vlastnosti

Vlastnosť Typ Predvolená hodnota Popis
slug / name string Názov priečinka Názov časti šablóny WordPress.
title string Názov odvodený od názvu Zobrazovaný názov v editore webu.
description string "" Zobrazovaný popis v editore webu.
area string "uncategorized" Oblasť časti šablóny. Bežné hodnoty sú header, footer a sidebar.
source / template / file string Automaticky zistený indexový súbor Voliteľná cesta k zdrojovému súboru vzhľadom na priečinok časti.
status string "publish" Stav časti šablóny.
meta object {} Vlastné metadáta pre pomocné API. Ukladajú sa sem aj neznáme kľúče manifestu.

Vytváranie označenia

Zdroje šablón webu používajú rovnaký analyzátor ako stránky a vzory:

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> sa zmení na blok core/group, ktorý sa vykreslí ako <main>, a jeho potomkovia vrátane značky bloku core/post-content sa stanú jeho vnútornými blokmi. Môžete použiť:

  • štandardné elementy HTML, ako sú <h1>, <p>, <ul>, <div> a sémantické elementy <main>, <header>, <footer>, <article> a <aside>
  • <block name="namespace/block">
  • <bs:namespace-block>
  • nakonfigurované predpony značiek blokov
  • Blockstudio bloky a komponenty

Bloky častí šablón dostanú atribút aktívnej témy, keď WordPress vykresľuje skompilovanú šablónu.

Úpravy v editore webu

Blockstudio poskytuje zdrojový súbor. WordPress spravuje používateľské úpravy.

Poradie vyhľadávania:

  1. Úprava v databáze editora webu
  2. Súbor .html aktívnej natívnej témy
  3. Zdroj Blockstudio založený na súbore
  4. Záložné zdroje nadradenej témy alebo doplnku

Keď používateľ uloží šablónu založenú na súbore Blockstudio v editore webu, WordPress vytvorí bežný záznam wp_template alebo wp_template_part v databáze. Tento uložený záznam má prednosť pred budúcimi zmenami súboru. Obnovením pôvodného stavu alebo odstránením úpravy sa znova zobrazí najnovší zdroj zo súboru.

Blockstudio nezapisuje úpravy editora webu späť do súborov v v1.

Výkon

Vyhľadávanie šablón sa ukladá do vyrovnávacej pamäte pre každú požiadavku a pretrváva spolu s metadátami sledovania súborov. Zmenou manifestu alebo zdrojového súboru sa zneplatní skompilovaný obsah vo vyrovnávacej pamäti. Úpravy v databáze sa neukladajú do vyrovnávacej pamäte: WordPress ich stále kontroluje ako prvé.

Integrácie za behu, ktoré skladajú súbory z viacerých koreňových priečinkov, môžu poskytnúť logický zdroj vyhľadávania pre šablóny a časti šablón. Manifesty a vybrané zdrojové šablóny môžu byť v rôznych fyzických koreňových priečinkoch a pritom zachovať jeden logický strom témy.

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

Odovzdajte výslovný zoznam, aby sa načítali a skompilovali iba presné názvy, cesty alebo cesty k zdrojom:

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

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

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

Vynechaním argumentu sa zachová úplné správanie registra. Prázdny zoznam nevráti žiadne položky. Požiadavky na bežné názvy a cesty zúžia vyhľadávanie na zodpovedajúce priečinky; vlastné názvy manifestov môžu vyžadovať prehľadanie metadát, nesúvisiace zdroje sa však stále neskompilujú ani nevrátia.

Dostupné sú aj pomocné funkcie pre šablóny:

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

Háčiky

Úplné rozhranie rozšírení šablón webu:

Hook Typ Popis
blockstudio/site_templates/template_paths Filter Upraví koreňové priečinky na vyhľadávanie úplných šablón.
blockstudio/site_templates/part_paths Filter Upraví koreňové priečinky na vyhľadávanie častí šablón.
blockstudio/site_templates/paths Filter Upraví oba zoznamy ciest ako templates a parts.
blockstudio/site_templates/template_candidates Filter Upraví kandidátov na zdrojové súbory pre manifest.
blockstudio/site_templates/templates Filter Upraví šablóny vrátené registrom API.
blockstudio/site_templates/parts Filter Upraví časti šablón vrátené registrom API.
blockstudio/site_templates/template_content Filter Upraví zdroj úplnej šablóny po kompilácii a pred analýzou.
blockstudio/site_templates/part_content Filter Upraví zdroj časti šablóny po kompilácii a pred analýzou.
blockstudio/site_templates/parser Filter Nahradí inštanciu Html_Parser pre jednu položku.
blockstudio/site_templates/source_compiled Akcia Spustí sa bezprostredne pred kompiláciou vybraného zdroja.
blockstudio/site_templates/discovered Akcia Spustí sa po neuloženom priebehu vyhľadávania a kompilácie.
blockstudio/site_templates/registered Akcia Spustí sa po uložení obnoveného registra.

Pridanie alebo nahradenie ciest na vyhľadávanie:

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

Filtrovanie nájdených údajov:

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

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

Filtrovanie zdroja pred analýzou:

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

Zmena kandidátov na zdroj alebo analyzátora:

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 a registered sú akcie životného cyklu obnovy vyrovnávacej pamäte. Pri použití už zahriatej vyrovnávacej pamäte registra sa nespustia.