Pāriet uz saturu

Vietnes redaktora veidnes un daļas no failiem

Bloku tēma apraksta savu izkārtojumu mapēs templates/*.html un parts/*.html: failos, kas pilni ar serializētiem bloku komentāriem, piemēram, <!-- wp:template-part {"slug":"header"} /-->. Nevienam nepatīk tos rakstīt manuāli, tāpēc tos parasti izveido vietnes redaktorā un eksportē. Tas darbojas, līdz divi cilvēki rediģē vienu veidni vai recenzentam jālasa atšķirību pārskats ar ekranētu JSON HTML komentāros.

Blockstudio ļauj rakstīt šīs pašas veidnes tāpat kā uz failiem balstītas lapas: mapē ar nelielu JSON manifestu un avota failu HTML līdzīgā iezīmēšanas valodā, izmantojot vienkāršus elementus, <block> tagus un savus Blockstudio blokus. Blockstudio kompilē avotu vietējā bloku iezīmēšanas valodā un nodod to WordPress kā tēmas failu. Vietnes redaktors turpina darboties kā līdz šim: lietotāji var pielāgot veidni, un, to atiestatot, tiek atjaunota faila versija.

Šajā pamācībā tiks izveidota galvenes un kājenes daļa, sākumlapas un atsevišķas ziņas veidnes, kā arī pielāgota veidne, ko redaktori var izvēlēties lapām. Pēc tam tiks parādīts, kā WordPress tās atlasa.

Mapju struktūra

Veidnes atrodas mapē templates/, bet veidņu daļas — mapē parts/. Katra ir mape ar manifestu un vienu avota failu:

Kods
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

Šīs ir tās pašas mapes templates/ un parts/, kuras WordPress nolasa bloku tēmai. Blockstudio vispirms pārmeklē aktīvo tēmu un pēc tam vecākobjekta tēmu. Mapes ar template.json vai part.json ir Blockstudio avoti; vienkārši .html faili blakus tām paliek vietējās WordPress veidnes.

Avota fails var būt index.php, index.blade.php, index.twig vai index.html — tie tiek pārbaudīti norādītajā secībā. Twig ir nepieciešams Timber, bet Blade — tā renderētāja pakotne, kā aprakstīts sadaļā Veidņu dzinēji.

1. darbība: galvenes daļa

Katrai daļai ir nepieciešams part.json. area norāda vietnes redaktoram, kur daļa atrodas:

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

Avotā izmantota tā pati sintakse kā Blockstudio lapās un rakstos. <div> kļūst par grupas bloku, atribūti kļūst par bloku atribūtiem, bet <block> elementi izveido jebkuru reģistrētu bloku:

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

Blockstudio to kompilē šādā bloku iezīmēšanas valodā:

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

Citādi tas būtu jāraksta manuāli. Arī jūsu pašu bloki darbojas tāpat: <block name="acme/announcement" />, <bs:acme-announcement /> tags vai konfigurēts tagu prefikss tiek kompilēts par attiecīgā bloka komentāru.

Daļa var būt tikai viena rindkopa. Šeit izmantots index.html, lai uzsvērtu, ka avots ir iezīmēšanas valoda, nevis programma:

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

Tas tiek kompilēts kā <!-- wp:paragraph --><p>Built with Acme.</p><!-- /wp:paragraph -->.

3. darbība: sākumlapas un atsevišķas ziņas veidnes

Veidnēs tiek izmantots template.json. slug ir precīzi jāatbilst WordPress veidņu hierarhijas nosaukumam, piemēram, front-page, single, page, archive, 404 vai single-product. Blockstudio to nekad nepievieno kā prefiksu.

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" />

Atsevišķas ziņas veidnei ir tāda pati struktūra, tikai tajā izmanto ziņu blokus:

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" />

Kompilētā atsevišķas ziņas veidne:

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> kļuva par grupas bloku ar tagName: "main", un veidņu daļu bloki pēc slug norāda uz 1. un 2. darbībā izveidotajām daļām. Kad WordPress renderē veidni, šīs atsauces tiek piesaistītas failos glabātajām daļām. Tādējādi sākumlapas izvade sākas ar <header class="wp-block-template-part">, kurā ir vietnes nosaukums un navigācija, un beidzas ar <footer class="wp-block-template-part">, kurā ir kājenes rindkopa.

4. darbība: pielāgota veidne lapām

Veidnes, kuru slug nav iekļauts hierarhijā, ir pielāgotas veidnes. Ar postTypes norādiet ziņu tipus, kuriem tās paredzētas; pēc tam redaktori tās var izvēlēties veidņu atlasītājā:

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' ) tagad ietver page-landing, un veidnes objektā ir iekļauts post_types: ["page"].

Avots tiek kompilēts vienreiz

Avots tiek nolasīts un kompilēts bloku iezīmēšanas valodā vienreiz, nevis katra pieprasījuma laikā. Tam nav pašreizējās ziņas vai pieprasījuma konteksta. index.php tiek nolasīts kā iezīmēšanas valoda: tajā iekļautais kods PHP netiek izpildīts, tāpēc <?php echo get_bloginfo( 'name' ); ?> tiek kompilēts tukšā rezultātā. Viss, kas atkarīgs no pieprasījuma, jāiekļauj blokā, kas tiek renderēts izpildlaikā: core/site-title, nevis izvadīts vietnes nosaukums; core/post-title, nevis the_title(); vai jūsu pašu dinamiskais Blockstudio bloks.

Kompilētie rezultāti tiek saglabāti kešatmiņā kopā ar failu pārraudzības metadatiem. Rediģējot manifestu vai avota failu, attiecīgā vienuma kešatmiņas saturs tiek anulēts, tāpēc nākamajā pieprasījumā redzamas izmaiņas bez atsevišķas būvēšanas darbības.

Kā WordPress atrod failus

Blockstudio pieslēdzas tām pašām atlases funkcijām, ko WordPress izmanto tēmas veidnēm. Failos glabātās veidnes get_block_templates() tiek attēlotas kopā ar source: "theme" un origin: "theme", tāpat kā vietējie tēmas faili, savukārt get_block_template( 'acme//header', 'wp_template_part' ) atgriež galvenes daļu ar tās area.

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

  1. Vietnes redaktora pielāgojums, kas saglabāts datubāzē.
  2. Vietējais .html fails aktīvajā tēmā.
  3. Failā glabātais Blockstudio avots.
  4. Vecākobjekta tēmas vai spraudņa rezerves varianti.

Šāda secība saglabā vietnes redaktora darbplūsmu. Kad lietotājs rediģē kājeni un saglabā izmaiņas, WordPress saglabā ziņu wp_template_part, un get_block_template() atgriež šo pielāgojumu kopā ar source: "custom". Vēlākas izmaiņas vienumā parts/footer/index.html nebūs redzamas, kamēr pastāv šis pielāgojums. Kad lietotājs atiestata daļu vai ziņa tiek dzēsta, atlase atgriežas pie faila un atkal atgriež jaunāko kompilēto avotu.

Blockstudio nesaglabā vietnes redaktora labojumus atpakaļ failos. Ja lietotāja izmaiņai jākļūst par jauno noklusējuma versiju, iekopējiet to avota failā un atiestatiet pielāgojumu.

Iekļautie index.html un slug vērtības

WordPress rekursīvi atrod .html failus mapēs templates/ un parts/. Tāpēc manifestu saturoša mape, kurā izmantots index.html, piemēram, parts/footer/index.html, tiktu parādīta arī kā vietējā daļa ar no ceļa atvasināto slug footer/index. Tā kā Blockstudio 7.6.6, manifestā deklarēta index.html ir pieejama tikai ar tai norādīto slug, tāpēc vietnes redaktorā ir norādīta viena kājene, nevis divas. Iekļautie .html faili bez manifesta netiek mainīti.

Veidņu pārbaude, izmantojot PHP

Klase Blockstudio\Site_Templates nolasa un kompilē avotus, kas noder testos un izvietošanas pārbaudēs:

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

Katrs vienums ietver slug, title, description, type (wp_template vai wp_template_part), status, source_type, veidnēm paredzēto postTypes vai daļām paredzēto area, meta un kompilēto content. Padodiet sarakstu, lai kompilētu tikai atlasītos vienumus, un skatiet ar šo atlasi saistītās problēmas, izmantojot selection_errors():

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

Citu mapju pievienošana

Lai nošķirtu Blockstudio avotus no vietējām veidnēm vai iekļautu tos spraudnī, pievienojiet atklāšanas saknes, izmantojot filtrus:

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

Filtri blockstudio/site_templates/template_content un part_content pielāgo avotu pirms tā parsēšanas, bet blockstudio/site_templates/parser aizstāj viena vienuma parsētāju. Pilns saraksts ir sadaļā Vietnes veidņu āķu tabula.

Kad kuru izmantot

Vēlaties Izmantojiet
Tēmas izkārtojumu, ko WordPress izvēlas URL: galveni, kājeni, atsevišķu ziņu vai arhīvu Vietnes veidnes un daļas
Maršrutējamu lapu, kuras saturs atrodas failos Uz failiem balstītas lapas
Atkārtoti izmantojamu sadaļu, ko redaktori ievieto lapā Raksti

Veidnes nerada ziņas — tās rada lapas. Piemēram, dokumentācijas sadaļa ir lapu kopa, kuras ziņas tiek attēlotas, izmantojot veidni, ko joprojām varat izveidot šeit.

Nākamie soļi