Hoppa till innehåll

Webbplatsredigerarens mallar och delar från filer

Ett blocktema beskriver sin layout i templates/*.html och parts/*.html: filer fyllda med serialiserade blockkommentarer som <!-- wp:template-part {"slug":"header"} /-->. Ingen tycker om att skriva sådana för hand, så de skapas vanligtvis i webbplatsredigeraren och exporteras. Det fungerar tills två personer redigerar samma mall eller en granskare måste läsa en diff av escapad JSON i HTML-kommentarer.

Blockstudio låter dig skriva samma mallar på samma sätt som filbaserade sidor: en mapp med ett litet JSON-manifest och en källfil med markup som liknar HTML, med vanliga element, taggarna <block> och dina egna Blockstudio-block. Blockstudio kompilerar källan till inbyggd blockmarkup och lämnar den till WordPress som en temafil. Webbplatsredigeraren fungerar fortfarande precis som tidigare: användare kan anpassa en mall, och när den återställs kommer filversionen tillbaka.

Den här guiden skapar en sidhuvud- och sidfotsdel, mallar för startsidan och enskilda inlägg, och en anpassad mall som redaktörer kan välja för sidor, och visar sedan hur WordPress hittar dem.

Mappstruktur

Mallar placeras i templates/ och malldelar i parts/. Var och en ligger i en mapp med ett manifest och en källfil:

Kod
theme/
├── templates/
│   ├── front-page/
│   │   ├── template.json
│   │   └── index.php
│   ├── single/
│   │   ├── template.json
│   │   └── index.php
│   └── page-landing/
│       ├── template.json
│       └── index.php
└── parts/
    ├── header/
    │   ├── part.json
    │   └── index.php
    └── footer/
        ├── part.json
        └── index.html

Det här är samma mappar templates/ och parts/ som WordPress läser för ett blocktema. Blockstudio söker först i det aktiva temat och sedan i föräldratemat. Mappar med template.json eller part.json är källor för Blockstudio; vanliga .html-filer bredvid dem förblir inbyggda WordPress-mallar.

Källfilen kan vara index.php, index.blade.php, index.twig eller index.html, kontrollerade i den ordningen. Twig kräver Timber och Blade kräver sitt renderingspaket, enligt beskrivningen i Mallmotorer.

Steg 1: Sidhuvudsdelen

Varje del behöver en part.json. area anger för webbplatsredigeraren var delen hör hemma:

JSON
{
  "slug": "header",
  "title": "Header",
  "description": "Site header with logo and navigation",
  "area": "header"
}

Källan använder samma syntax som sidor och mönster i Blockstudio. En <div> blir ett gruppblock, attribut blir blockattribut och element av typen <block> skapar det registrerade blocket:

PHP
<div layout='{"type":"flex","justifyContent":"space-between"}'>
  <block name="core/site-title" />
  <block name="core/navigation" overlayMenu="mobile" />
</div>

Blockstudio kompilerar den till den här blockmarkuppen:

HTML
<!-- wp:group {"layout":{"type":"flex","justifyContent":"space-between"}} --><div class="wp-block-group is-layout-flex"><!-- wp:site-title /--><!-- wp:navigation {"overlayMenu":"mobile"} /--></div><!-- /wp:group -->

Det är det du annars skulle ha skrivit för hand. Dina egna block fungerar på samma sätt: <block name="acme/announcement" />, en tagg av typen <bs:acme-announcement /> eller ett konfigurerat taggprefix kompileras alla till blockkommentaren för det blocket.

En del kan bestå av ett enda stycke. Den här använder index.html för att visa att källan är markup, inte ett program:

JSON
{
  "slug": "footer",
  "title": "Footer",
  "area": "footer"
}
HTML
<p>Built with Acme.</p>

Den kompileras till <!-- wp:paragraph --><p>Built with Acme.</p><!-- /wp:paragraph -->.

Steg 3: Startsida och mallar för enskilda inlägg

Mallar använder template.json. slug måste vara ett exakt hierarkinamn för en WordPress-mall, som front-page, single, page, archive, 404 eller single-product. Blockstudio läggs aldrig framför namnet.

JSON
{
  "slug": "front-page",
  "title": "Front Page",
  "description": "Homepage template"
}
PHP
<block name="core/template-part" slug="header" tagName="header" />

<main>
  <block name="core/post-content" />
</main>

<block name="core/template-part" slug="footer" tagName="footer" />

Mallen för enskilda inlägg har samma struktur men använder inläggsblock:

JSON
{
  "slug": "single",
  "title": "Single Post"
}
PHP
<block name="core/template-part" slug="header" tagName="header" />

<main>
  <block name="core/post-title" level="1" />
  <block name="core/post-date" />
  <block name="core/post-content" />
</main>

<block name="core/template-part" slug="footer" tagName="footer" />

Den kompilerade mallen för enskilda inlägg:

HTML
<!-- wp:template-part {"slug":"header","tagName":"header"} /--><!-- wp:group {"tagName":"main"} --><main class="wp-block-group"><!-- wp:post-title {"level":1} /--><!-- wp:post-date /--><!-- wp:post-content /--></main><!-- /wp:group --><!-- wp:template-part {"slug":"footer","tagName":"footer"} /-->

<main> blev ett gruppblock med tagName: "main", och blocken för malldelarna refererar till delarna från steg 1 och 2 med deras sluggar. När WordPress renderar mallen pekar referenserna på de filbaserade delarna, så att startsidans utdata börjar med <header class="wp-block-template-part"> som innehåller webbplatsens titel och navigering, och slutar med <footer class="wp-block-template-part"> som innehåller stycket i sidfoten.

Steg 4: En anpassad mall för sidor

Mallar vars slug inte ingår i hierarkin är anpassade mallar. Ange vilka inläggstyper de gäller med postTypes, så kan redaktörer välja dem i mallväljaren:

JSON
{
  "slug": "page-landing",
  "title": "Landing Page",
  "description": "Full-width page without a header",
  "postTypes": ["page"]
}
PHP
<main>
  <block name="core/post-content" />
</main>

<block name="core/template-part" slug="footer" tagName="footer" />

get_block_templates( array( 'post_type' => 'page' ), 'wp_template' ) innehåller nu page-landing, och mallobjektet har post_types: ["page"].

Källor kompileras en gång

Källan läses och kompileras till blockmarkup en gång, inte vid varje begäran. Den har inget aktuellt inlägg och ingen begärandekontext. index.php läses som markup: kod i PHP körs inte, så <?php echo get_bloginfo( 'name' ); ?> kompileras till ingenting. Allt som beror på begäran hör hemma i ett block som renderas vid körning: core/site-title i stället för ett utskrivet webbplatsnamn, core/post-title i stället för the_title() eller ett dynamiskt Blockstudio-block som du skapat själv.

Kompilerade resultat cachelagras tillsammans med metadata för filbevakning. Om ett manifest eller en källfil ändras ogiltigförklaras det cachelagrade innehållet för objektet, så att nästa begäran ser ändringen utan något separat byggsteg.

Hur WordPress hittar filerna

Blockstudio använder samma uppslagningar som WordPress för temamallar. I get_block_templates() visas de filbaserade mallarna med source: "theme" och origin: "theme", precis som inbyggda temafiler, och get_block_template( 'acme//header', 'wp_template_part' ) returnerar sidhuvudsdelen med dess area.

Sökordningen är:

  1. En anpassning i webbplatsredigeraren som lagrats i databasen.
  2. En inbyggd .html-fil i det aktiva temat.
  3. Den filbaserade källan Blockstudio.
  4. Reservlösningar från föräldratemat eller ett tillägg.

Den ordningen bevarar arbetsflödet i webbplatsredigeraren. När en användare redigerar sidfoten och sparar lagrar WordPress ett wp_template_part-inlägg, och get_block_template() returnerar anpassningen med source: "custom". Senare ändringar av parts/footer/index.html visas inte så länge anpassningen finns. När användaren återställer delen eller inlägget tas bort, går uppslagningen tillbaka till filen och returnerar den senaste kompilerade källan igen.

Blockstudio skriver inte tillbaka ändringar från webbplatsredigeraren till filer. Om en användares ändring ska bli det nya standardläget kopierar du den till källfilen och återställer anpassningen.

Nästlade index.html och sluggar

WordPress hittar filer av typen .html rekursivt i templates/ och parts/. En manifestmapp som använder index.html, till exempel parts/footer/index.html, skulle därför också visas som en inbyggd del med den sökvägsbaserade sluggen footer/index. Eftersom Blockstudio 7.6.6 visas en manifestägd index.html bara under sin deklarerade slug, så webbplatsredigeraren visar en sidfot, inte två. Nästlade filer av typen .html utan manifest lämnas orörda.

Kontrollera mallar från PHP

Klassen Blockstudio\Site_Templates läser och kompilerar källorna, vilket är användbart vid tester och driftsättningskontroller:

PHP
$templates = Blockstudio\Site_Templates::templates();
$header    = Blockstudio\Site_Templates::get_part( 'header' );

echo $header['area'];    // header
echo $header['content']; // compiled block markup

$errors = Blockstudio\Site_Templates::errors();

Varje objekt innehåller slug, title, description, type (wp_template eller wp_template_part), status, source_type, postTypes för mallar eller area för delar, meta och den kompilerade content. Skicka en lista för att bara kompilera valda objekt och läs problem för urvalet med selection_errors():

PHP
$selected = Blockstudio\Site_Templates::templates( array( 'front-page' ) );
$errors   = Blockstudio\Site_Templates::selection_errors( 'templates' );

Lägga till andra mappar

Om du vill hålla Blockstudio-källor åtskilda från inbyggda mallar eller leverera dem från ett tillägg, lägger du till sökvägar för identifiering med filter:

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

Filtren blockstudio/site_templates/template_content och part_content justerar en källa innan den tolkas, och blockstudio/site_templates/parser byter ut tolken för ett enskilt objekt. Hela listan finns i tabellen Krokar för webbplatsmallar.

När du ska använda vad

Du vill ha Använd
Temalayouten WordPress väljer för en URL: sidhuvud, sidfot, enskilt inlägg, arkiv Webbplatsmallar och delar
En åtkomlig sida med innehåll i filer Filbaserade sidor
Ett återanvändbart avsnitt som redaktörer kan infoga Mönster

Mallar skapar inte inlägg. Det gör sidor. Ett dokumentationsavsnitt är till exempel en sidgrupp vars inlägg renderas med en mall som du fortfarande kan skapa här.

Nästa steg