Pāriet uz saturu

Vietnes veidnes

Vietnes veidnes ļauj bloku tēmām definēt WordPress wp_template un wp_template_part avotus ar to pašu failu prioritātes sintaksi, ko izmanto Blockstudio lapas un raksti.

Izmantojiet vietnes veidnes, ja vēlaties kontrolēt motīva izkārtojumu, ko WordPress atlasa, izmantojot Site Editor veidņu hierarhiju: sākumlapa, atsevišķi ieraksti, arhīvi, meklēšana, 404 lapas, galvenes, kājenes un citas veidņu daļas.

Lapas, raksti vai vietnes veidnes?

Funkcija Izveido Vispiemērotākā lietošanai
Lapas Ierakstus vai pielāgota ieraksta veida vienumus Satura lapām, dokumentācijas lapām, galvenajām lapām un maršrutējamam saturam.
Raksti Bloku rakstus Atkārtoti izmantojamām sadaļām, ko ievieto redaktori.
Vietnes veidnes wp_template un wp_template_part failu avotus Motīva izkārtojumam, ko kontrolē Site Editor un WordPress veidņu hierarhija.

Vietnes veidnes neizveido parastas lapas. Tās nodrošina faila avotu, ko WordPress izmanto, nosakot bloku tēmas veidni. Ja lietotājs pielāgo veidni Site Editor, WordPress saglabā šīs izmaiņas datubāzē, un tās ir prioritāras pār faila avotu, līdz tiek atiestatītas.

Mapju struktūra

Pilnās veidnes ievietojiet mapē templates/, bet veidņu daļas — mapē 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

Katrā mapē ir manifests un viens avota fails.

Fails Dzinējs
index.php HTML līdzīgs bloka marķējums, nolasīts tāds, kāds ir (PHP kods netiek izpildīts)
index.blade.php Blade
index.twig Twig
index.html HTML līdzīgs bloka marķējums

Ja ir vairāki avota faili, Blockstudio izmanto šādu secību:

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

WordPress arī rekursīvi atrod .html failus un parasti atklāj ligzdotu index.html, izmantojot no ceļa iegūtu slug, piemēram, header/index. Ja fails pieder Blockstudio manifestam, Blockstudio noņem dublikātu, kas iegūts no ceļa, un atklāj tikai manifestā norādīto slug. Ligzdotās vietējās .html veidnes bez Blockstudio manifesta paliek nemainītas.

Avots tiek vienreiz kompilēts vietējā WordPress bloka marķējumā. Tam nevajadzētu būt atkarīgam no pašreizējā pieprasījuma vai ieraksta. Izpildlaika darbības iekļaujiet dinamiskajos blokos.

template.json

template.json definē pilnu Site Editor veidni.

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

Rekvizīti

Īpašība Tips Noklusējums Apraksts
slug / name string Mapes nosaukums WordPress veidnes slug. Izmantojiet precīzus hierarhijas slug, piemēram, front-page, single, archive-product vai 404.
title string Nosaukums no slug Attēlotais nosaukums Site Editor.
description string "" Attēlojamais apraksts Site Editor.
postTypes string[] [] Ierakstu veidi pielāgotām veidnēm. Kodola hierarhijas veidnēm šo var nenorādīt.
source / template / file string Automātiski noteikts indeksa fails Neobligāts avota faila ceļš attiecībā pret veidnes mapi.
status string "publish" Veidnes statuss.
sync boolean false Rezervēts turpmākai materializēšanai datubāzē. Lietotāja pielāgojumi nekad netiek pārrakstīti v1.
meta object {} Pielāgoti metadati palīg-API. Nezināmas manifesta atslēgas tiek saglabātas arī šeit.

Veidņu slug netiek prefiksēti. WordPress veidņu hierarhijai ir nepieciešami precīzi nosaukumi:

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 definē Site Editor veidnes daļu.

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

Rekvizīti

Īpašība Tips Noklusējums Apraksts
slug / name string Mapes nosaukums WordPress veidnes daļas slug.
title string Nosaukums no slug Attēlotais nosaukums Site Editor.
description string "" Attēlojamais apraksts Site Editor.
area string "uncategorized" Veidnes daļas apgabals. Biežākās vērtības ir header, footer un sidebar.
source / template / file string Automātiski noteikts indeksa fails Neobligāts avota faila ceļš attiecībā pret daļas mapi.
status string "publish" Veidnes daļas statuss.
meta object {} Pielāgoti metadati palīg-API. Nezināmas manifesta atslēgas tiek saglabātas arī šeit.

Marķējuma veidošana

Vietnes veidņu avotiem izmanto to pašu parsētāju, ko lapām un rakstiem:

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>

Elements <main> kļūst par bloku core/group, kas tiek renderēts kā <main>, bet tā bērnelementi, tostarp bloka tags core/post-content, kļūst par iekšējiem blokiem. Var izmantot:

  • standarta HTML elementus, piemēram, <h1>, <p>, <ul>, <div>, kā arī sadaļu elementus <main>, <header>, <footer>, <article> un <aside>
  • <block name="namespace/block">
  • <bs:namespace-block>
  • konfigurētus bloku tagu prefiksus
  • Blockstudio blokus un komponentus

Kad WordPress renderē kompilēto veidni, veidņu daļu bloki saņem aktīvās tēmas atribūtu.

Site Editor pielāgojumi

Blockstudio nodrošina faila avotu. WordPress pārvalda lietotāja pielāgojumus.

Meklēšanas secība ir šāda:

  1. Site Editor datubāzes pielāgojums
  2. aktīvās vietējās tēmas fails .html
  3. faila avots Blockstudio
  4. vecākas tēmas vai spraudņa atkāpšanās iespējas

Kad lietotājs Site Editor saglabā veidni, kuras faila avots ir Blockstudio, WordPress izveido parastu datubāzes ierakstu — wp_template vai wp_template_part. Šis saglabātais ieraksts ir prioritārs pār turpmākajām faila izmaiņām. Atiestatot vai dzēšot pielāgojumu, atkal tiek izmantots jaunākais faila avots.

Blockstudio neieraksta Site Editor labojumus atpakaļ failos, kas atrodas v1.

Veiktspēja

Veidņu atklāšana tiek kešota katram pieprasījumam un saglabāta kopā ar failu uzraudzības metadatiem. Mainot manifestu vai avota failu, kešotais kompilētais saturs tiek atzīmēts kā nederīgs. Datubāzes pielāgojumi netiek kešoti: WordPress vienmēr tos pārbauda vispirms.

Izpildlaika integrācijas, kas apvieno failus no vairākām saknēm, veidnēm un veidņu daļām var nodrošināt loģisku atklāšanas avotu. Manifests un atlasītās avota veidnes var atrasties dažādās fiziskajās saknēs, vienlaikus saglabājot vienotu loģisku tēmas koku.

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

Padodiet skaidru sarakstu, lai nolasītu un kompilētu tikai precīzas sluga vērtības, ceļus vai avota ceļus:

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

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

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

Ja arguments netiek norādīts, tiek saglabāta pilna reģistra darbība. Tukšs saraksts neatgriež nevienu vienumu. Pieprasījumi pēc parastiem sluga un ceļa nosaukumiem sašaurina atklāšanu līdz atbilstošajiem direktorijiem. Pielāgotiem manifesta slug var būt nepieciešama metadatu skenēšana, taču nesaistīti avoti joprojām netiek kompilēti vai atgriezti.

Pieejamas arī veidņu palīgfunkcijas:

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

Āķi

Pilns vietnes veidņu paplašināšanas punktu saraksts:

Āķis Tips Apraksts
blockstudio/site_templates/template_paths Filtrs Pielāgo pilno veidņu atklāšanas saknes.
blockstudio/site_templates/part_paths Filtrs Pielāgo veidņu daļu atklāšanas saknes.
blockstudio/site_templates/paths Filtrs Pielāgo abus ceļu sarakstus kā templates un parts.
blockstudio/site_templates/template_candidates Filtrs Pielāgo avota failu kandidātus manifestam.
blockstudio/site_templates/templates Filtrs Pielāgo reģistra API atgrieztās veidnes.
blockstudio/site_templates/parts Filtrs Pielāgo reģistra API atgrieztās veidņu daļas.
blockstudio/site_templates/template_content Filtrs Pielāgo kompilēto pilnās veidnes avotu pirms parsēšanas.
blockstudio/site_templates/part_content Filtrs Pielāgo kompilēto veidnes daļas avotu pirms parsēšanas.
blockstudio/site_templates/parser Filtrs Aizstāj viena vienuma Html_Parser instanci.
blockstudio/site_templates/source_compiled Darbība Tiek izpildīta tieši pirms viena atlasītā avota kompilēšanas.
blockstudio/site_templates/discovered Darbība Tiek izpildīta pēc aukstās atklāšanas un kompilēšanas cikla.
blockstudio/site_templates/registered Darbība Tiek izpildīta pēc atjaunotā reģistra saglabāšanas.

Pievienojiet vai aizstājiet atklāšanas ceļus:

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

Filtrējiet atklātos datus:

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

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

Filtrējiet avotu pirms parsēšanas:

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

Mainiet avota kandidātus vai parsētāju:

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 un registered ir kešatmiņas atjaunošanas dzīves cikla darbības. Tās netiek izpildītas, ja reģistrs tiek ielādēts no siltās kešatmiņas.