Gå til indhold

Webstedsskabeloner

Site Templates lader bloktemaer definere WordPress wp_template og wp_template_part-kilder med den samme filbaserede syntaks, som bruges af Blockstudio sider og mønstre.

Brug webstedsskabeloner, når du vil styre temalayoutet, som WordPress vælger gennem Site Editors skabelonhierarki: forsiden, enkelte indlæg, arkiver, søgning, 404-sider, sidehoveder, sidefødder og andre skabelondele.

Sider, mønstre eller webstedsskabeloner?

Funktion Opretter Bedst til
Sider Indlæg eller brugerdefinerede indholdstypeposter Faktiske indholdssider, dokumentationssider, landingssider og indhold, der kan tilgås via ruter.
Mønstre Blokmønstre Genanvendelige sektioner, som redaktører indsætter.
Webstedsskabeloner wp_template– og wp_template_part-filkilder Temalayout styret af Site Editor og WordPress-skabelonhierarkiet.

Webstedsskabeloner opretter ikke almindelige sider. De leverer den filkilde, WordPress bruger, når en bloktemaskabelon findes. Hvis en bruger tilpasser skabelonen i Site Editor, gemmer WordPress tilpasningen i databasen, og den har forrang for filkilden, indtil den nulstilles.

Mappestruktur

Placer hele skabeloner i templates/ og skabelondele i 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

Hver mappe har et manifest og én kildefil.

Fil Motor
index.php HTML-lignende blokmarkup, læses som den er (PHP-kode køres ikke)
index.blade.php Blade
index.twig Twig
index.html HTML-lignende blokmarkup

Hvis der findes flere kildefiler, bruger Blockstudio denne rækkefølge:

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

WordPress finder også .html-filer rekursivt og viser normalt en indlejret index.html under dens stibaserede slug, f.eks. header/index. Når filen tilhører et Blockstudio-manifest, fjerner Blockstudio den stibaserede dublet og viser kun manifestets erklærede slug. Indlejrede native .html-skabeloner uden et Blockstudio-manifest forbliver uændrede.

Kilden kompileres én gang til native WordPress-blokmarkup. Den bør ikke afhænge af den aktuelle forespørgsel eller det aktuelle indlæg. Placér runtime-adfærd i dynamiske blokke.

template.json

template.json definerer en fuld Site Editor-skabelon.

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

Egenskaber

Egenskab Type Standard Beskrivelse
slug / name string Mappenavn Slug til WordPress-skabelonen. Brug nøjagtige hierarkislugs som front-page, single, archive-product eller 404.
title string Titel fra slug Visningstitel i Site Editor.
description string "" Visningsbeskrivelse i Site Editor.
postTypes string[] [] Indholdstyper til brugerdefinerede skabeloner. Skabeloner i kernehierarkiet kan udelade dette.
source / template / file string Automatisk fundet indeksfil Valgfri kildesti relativ til skabelonmappen.
status string "publish" Skabelonstatus.
sync boolean false Reserveret til fremtidig materialisering i databasen. Brugertilpasninger overskrives aldrig i v1.
meta object {} Brugerdefinerede metadata til hjælpe-API’er. Ukendte manifestnøgler gemmes også her.

Skabelonslugs har ikke præfiks. WordPress kræver præcise navne til skabelonhierarkiet:

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 definerer en Site Editor-skabelondel.

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

Egenskaber

Egenskab Type Standard Beskrivelse
slug / name string Mappenavn Slug til WordPress-skabelondelen.
title string Titel fra slug Visningstitel i Site Editor.
description string "" Visningsbeskrivelse i Site Editor.
area string "uncategorized" Område for skabelondelen. Almindelige værdier er header, footer og sidebar.
source / template / file string Automatisk fundet indeksfil Valgfri kildesti relativ til delens mappe.
status string "publish" Status for skabelondelen.
meta object {} Brugerdefinerede metadata til hjælpe-API’er. Ukendte manifestnøgler gemmes også her.

Redigering af markup

Kilder til webstedsskabeloner bruger samme parser som sider og mønstre:

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>

Elementet <main> bliver til en core/group-blok, der gengives som <main>, og dets underordnede elementer, herunder bloktagget core/post-content, bliver til dets indre blokke. Du kan bruge:

  • standard-HTML-elementer som <h1>, <p>, <ul>, <div> samt sektionsinddelingselementerne <main>, <header>, <footer>, <article> og <aside>
  • <block name="namespace/block">
  • <bs:namespace-block>
  • konfigurerede præfikser til bloktags
  • Blockstudio-blokke og komponenter

Blokke for skabelondele modtager det aktive tema-attribut, når WordPress gengiver den kompilerede skabelon.

Tilpasninger i Site Editor

Blockstudio leverer filkilden. WordPress ejer brugertilpasningerne.

Opslagsrækkefølgen er:

  1. Databasetilpasning fra Site Editor
  2. .html-fil i det aktive native tema
  3. filbaseret kilde fra Blockstudio
  4. reserver i overordnet tema eller plugin

Når en bruger gemmer en filbaseret Blockstudio-skabelon i Site Editor, opretter WordPress en almindelig databasepost af typen wp_template eller wp_template_part. Den gemte post har forrang for fremtidige filændringer. Hvis tilpasningen nulstilles eller slettes, vises den seneste filbaserede kilde igen.

Blockstudio skriver ikke Site Editor-redigeringer tilbage til filer i v1.

Ydeevne

Skabelonsøgning cachelagres pr. forespørgsel og gemmes med metadata fra filovervågning. Hvis et manifest eller en kildefil ændres, ugyldiggøres det cachelagrede kompilerede indhold. Databasetilpasninger overskrives ikke i cachen: WordPress kontrollerer dem stadig først.

Runtime-integrationer, der sammensætter filer fra flere rødder, kan levere en logisk kilde til søgning for skabeloner og skabelondele. Manifester og valgte kildeskabeloner kan ligge i forskellige fysiske rødder, mens de tilsammen udgør ét logisk tematræ.

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

Angiv en eksplicit liste for kun at læse og kompilere præcise slugs, stier eller kildestier:

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

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

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

Hvis argumentet udelades, bevares den fulde samlingsadfærd. En tom liste returnerer ingen elementer. Konventionelle slug- og stiangivelser begrænser søgningen til de tilsvarende mapper; brugerdefinerede manifest-slugs kan kræve en metadatascanning, men uvedkommende kilder kompileres eller returneres stadig ikke.

Hjælpefunktioner til skabeloner er også tilgængelige:

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

Hooks

Hele udvidelsesfladen for webstedsskabeloner er:

Hook Type Beskrivelse
blockstudio/site_templates/template_paths Filter Juster søgestier for hele skabeloner.
blockstudio/site_templates/part_paths Filter Juster søgestier for skabelondele.
blockstudio/site_templates/paths Filter Juster begge stiliste som templates og parts.
blockstudio/site_templates/template_candidates Filter Juster kandidater til kildefiler for et manifest.
blockstudio/site_templates/templates Filter Juster skabeloner, der returneres af samlingens API.
blockstudio/site_templates/parts Filter Juster skabelondele, der returneres af samlingens API.
blockstudio/site_templates/template_content Filter Juster kilden til kompileret helskabelon før parsing.
blockstudio/site_templates/part_content Filter Juster kilden til kompileret skabelondel før parsing.
blockstudio/site_templates/parser Filter Erstat forekomsten af Html_Parser for ét element.
blockstudio/site_templates/source_compiled Handling Køres umiddelbart før én valgt kilde kompileres.
blockstudio/site_templates/discovered Handling Køres efter en kold søge- og kompileringsrunde.
blockstudio/site_templates/registered Handling Køres, når den genopbyggede samling er gemt.

Tilføj eller erstat søgestier:

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ér fundne data:

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

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

Filtrér kilde før parsing:

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

Skift kildekandidater eller parser:

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 og registered er handlinger i livscyklussen for genopbygning af cachen. De køres ikke ved et varmt cachehit for samlingen.