Ugrás a tartalomhoz

Webhelysablonok

A webhelysablonok lehetővé teszik, hogy a blokk-témák WordPress wp_template és wp_template_part forrásokat határozzanak meg ugyanazzal a fájlközpontú szintaxissal, amelyet az Blockstudio oldalak és minták használnak.

Akkor használjon webhelysablonokat, ha azt szeretné szabályozni, hogy a WordPress milyen témabeli elrendezést válasszon ki a Site Editor sablonhierarchiáján keresztül: főoldal, egyedi bejegyzések, archívumok, keresés, 404 oldalak, fejlécek, láblécek és egyéb sablonrészek.

Oldalak, minták vagy webhelysablonok?

Funkció Létrehozott elemek Leginkább erre alkalmas
Oldalak Bejegyzések vagy egyéni bejegyzéstípusú elemek Valódi tartalmi oldalak, dokumentációs oldalak, céloldalak és útvonalon elérhető tartalmak.
Minták Blokkminták Szerkesztők által beszúrt, újra felhasználható szakaszok.
Webhelysablonok wp_template és wp_template_part fájlforrások A Site Editor és az WordPress sablonhierarchia által szabályozott témabeli elrendezés.

A webhelysablonok nem hoznak létre normál oldalakat. A fájlforrást biztosítják, amelyet az WordPress a blokk-témasablon feloldásakor használ. Ha egy felhasználó testre szabja a sablont a Site Editorban, az WordPress elmenti ezt a testreszabást az adatbázisba, és az a visszaállításig elsőbbséget élvez a fájlforrással szemben.

Mappastruktúra

A teljes sablonokat helyezze a templates/, a sablonrészeket pedig a parts/ mappába:

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

Minden mappa egy jegyzéket és egy forrásfájlt tartalmaz.

Fájl Motor
index.php HTML-szerű blokkjelölés, változtatás nélkül beolvasva (a PHP kód nem fut le)
index.blade.php Blade
index.twig Twig
index.html HTML-szerű blokkjelölés

Ha több forrásfájl is létezik, a Blockstudio a következő sorrendet használja:

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

A WordPress rekurzívan is felderíti a .html fájlokat, és általában egy beágyazott index.html elemet tesz elérhetővé az útvonalból képzett slug alatt, például header/index. Ha ez a fájl egy Blockstudio jegyzékhez tartozik, a Blockstudio eltávolítja az útvonalból képzett duplikátumot, és csak a jegyzékben meghatározott slug elemet teszi elérhetővé. A Blockstudio jegyzék nélküli beágyazott natív .html sablonok változatlanok maradnak.

A forrás egyszer kerül lefordításra natív WordPress blokkjelöléssé. Nem függhet az aktuális kéréstől vagy bejegyzéstől. A futásidejű viselkedést dinamikus blokkokba helyezze.

template.json

A template.json teljes Site Editor-sablont határoz meg.

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

Tulajdonságok

Tulajdonság Típus Alapértelmezett Leírás
slug / name string Mappanév WordPress sablon slugja. Használjon pontos hierarchia-slugokat, például front-page, single, archive-product vagy 404.
title string Slugból képzett cím Megjelenített cím a Site Editorban.
description string "" Megjelenített leírás a Site Editorban.
postTypes string[] [] Bejegyzéstípusok az egyéni sablonokhoz. Az alapvető hierarchiasablonoknál ez elhagyható.
source / template / file string Automatikusan felismert indexfájl Választható forrásfájl-útvonal a sablonmappához képest.
status string "publish" Sablonállapot.
sync boolean false Jövőbeli adatbázisba íráshoz fenntartva. A felhasználói testreszabások soha nem íródnak felül az v1 felületen.
meta object {} Egyéni metaadatok a segéd-API-khoz. Az ismeretlen jegyzékkulcsok szintén itt tárolódnak.

A sablon-slugoknak nincs előtagjuk. Az WordPress-nek pontos nevekre van szüksége a sablonhierarchiához:

Text
index
home
front-page
single
single-post
single-product
archive
archive-product
page
page-about
404
search
taxonomy-product_cat

part.json

A part.json Site Editor-sablonrészt határoz meg.

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

Tulajdonságok

Tulajdonság Típus Alapértelmezett Leírás
slug / name string Mappanév WordPress sablonrész slugja.
title string Slugból képzett cím Megjelenített cím a Site Editorban.
description string "" Megjelenített leírás a Site Editorban.
area string "uncategorized" Sablonrész-terület. Gyakori értékek: header, footer és sidebar.
source / template / file string Automatikusan felismert indexfájl Választható forrásfájl-útvonal a sablonrész mappájához képest.
status string "publish" Sablonrész állapota.
meta object {} Egyéni metaadatok a segéd-API-khoz. Az ismeretlen jegyzékkulcsok szintén itt tárolódnak.

Jelölés készítése

A webhelysablonok forrásai ugyanazt az elemzőt használják, mint az oldalak és minták:

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>

A <main> elem egy core/group blokkká alakul, amely <main>-ként jelenik meg, és a gyermekelemei, köztük a core/post-content blokkcímke is, belső blokkokká válnak. A következőket használhatja:

  • szabványos HTML elemek, például <h1>, <p>, <ul>, <div>, valamint a szakaszoló elemek: <main>, <header>, <footer>, <article> és <aside>
  • <block name="namespace/block">
  • <bs:namespace-block>
  • konfigurált blokkelem-előtagok
  • Blockstudio blokkok és komponensek

Amikor a WordPress megjeleníti a lefordított sablont, a sablonrész-blokkok megkapják az aktív téma attribútumát.

Testreszabások a Site Editorban

A Blockstudio biztosítja a fájlforrást. A felhasználói testreszabások az WordPress kezelésében vannak.

A keresés sorrendje:

  1. Site Editorban mentett adatbázis-testreszabás
  2. Az aktív téma natív .html fájlja
  3. Az Blockstudio fájlalapú forrása
  4. Szülőtémából vagy bővítményből származó tartalékok

Amikor a felhasználó egy Blockstudio fájlalapú sablont ment a Site Editorban, az WordPress létrehoz egy normál wp_template vagy wp_template_part adatbázis-bejegyzést. Az elmentett bejegyzés elsőbbséget élvez a későbbi fájlmódosításokkal szemben. A testreszabás visszaállításával vagy törlésével ismét a legfrissebb fájlalapú forrás jelenik meg.

Az Blockstudio nem írja vissza a Site Editor módosításait a v1 fájljaiba.

Teljesítmény

A sablonok felderítése kérésenként gyorsítótárazott, és fájlfigyelési metaadatokkal együtt tárolódik. A jegyzék vagy a forrásfájl módosítása érvényteleníti a lefordított tartalom gyorsítótárát. Az adatbázis-testreszabások nem kerülnek gyorsítótárba: az WordPress továbbra is először ezeket ellenőrzi.

A több gyökérből származó fájlokat összeállító futásidejű integrációk logikai felderítési forrást adhatnak meg a sablonokhoz és sablonrészekhez. A jegyzékek és a kiválasztott forrássablonok különböző fizikai gyökerekben lehetnek, miközben egyetlen logikai témakönyvtárat alkotnak.

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

Adjon meg egy explicit listát, ha csak a pontos slugokat, útvonalakat vagy forrásútvonalakat szeretné beolvasni és lefordítani:

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

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

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

Az argumentum elhagyása megőrzi a teljes jegyzék működését. Üres lista megadásakor nem tér vissza egyetlen elem sem. A szokásos slug- és útvonal-kérések a megfelelő könyvtárakra szűkítik a felderítést; az egyéni jegyzék-slugok metaadat-vizsgálatot igényelhetnek, de a nem kapcsolódó források nem lesznek lefordítva és nem kerülnek vissza.

Sablonsegédfüggvények is elérhetők:

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

Hookok

A webhelysablonok bővítési pontjainak teljes listája:

Hook Típus Leírás
blockstudio/site_templates/template_paths Szűrő A teljes sablonok felderítési gyökereinek módosítása.
blockstudio/site_templates/part_paths Szűrő A sablonrészek felderítési gyökereinek módosítása.
blockstudio/site_templates/paths Szűrő Mindkét útvonal-lista módosítása templates és parts értékként.
blockstudio/site_templates/template_candidates Szűrő A jegyzék forrásfájl-jelöltjeinek módosítása.
blockstudio/site_templates/templates Szűrő A jegyzék API által visszaadott sablonok módosítása.
blockstudio/site_templates/parts Szűrő A jegyzék API által visszaadott sablonrészek módosítása.
blockstudio/site_templates/template_content Szűrő A teljes sablon lefordított forrásának módosítása az elemzés előtt.
blockstudio/site_templates/part_content Szűrő A sablonrész lefordított forrásának módosítása az elemzés előtt.
blockstudio/site_templates/parser Szűrő Az Html_Parser példányának lecserélése egy elemnél.
blockstudio/site_templates/source_compiled Művelet Közvetlenül egy kiválasztott forrás lefordítása előtt fut le.
blockstudio/site_templates/discovered Művelet A hideg felderítési és fordítási menet után fut le.
blockstudio/site_templates/registered Művelet Az újraépített jegyzék tartós tárolása után fut le.

Felderítési útvonalak hozzáadása vagy cseréje:

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

A felderített adatok szűrése:

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

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

A forrás szűrése az elemzés előtt:

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

A forrásjelöltek vagy az elemző módosítása:

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

A discovered és a registered a gyorsítótár újraépítésének életciklus-műveletei. Meleg jegyzék-gyorsítótár találatakor nem futnak le.