Към съдържанието

Шаблони и части на редактора на сайта от файлове

Block theme описва оформлението си в templates/*.html и parts/*.html: файлове, пълни със сериализирани коментари за блокове, като <!-- wp:template-part {"slug":"header"} /-->. Никой не обича да ги пише на ръка, затова обикновено се създават в редактора на сайта и се експортират. Това работи, докато двама души не редактират един и същ шаблон или рецензент не трябва да прочете разлики с екранирани JSON в коментарите на HTML.

Blockstudio ви позволява да пишете същите шаблони по начина, по който създавате страници от файлове: папка с малък манифест JSON и изходен файл с маркиране като HTML, използвайки обикновени елементи, тагове <block> и свои блокове Blockstudio. Blockstudio компилира изходния код до собствено маркиране на блокове и го подава на WordPress като файл на темата. Редакторът на сайта продължава да работи по същия начин: потребителите могат да персонализират шаблон, а при нулиране се възстановява версията от файла.

Това ръководство създава част за хедър и футър, шаблони за начална и единична страница, както и персонализиран шаблон, който редакторите могат да изберат за страници, след което показва как WordPress ги разрешава.

Структура на папките

Шаблоните се поставят в templates/, а частите за шаблони — в parts/. Всеки елемент е папка с манифест и един изходен файл:

Код
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

Това са същите папки templates/ и parts/, които WordPress чете за block theme. Blockstudio първо сканира активната тема, а след това родителската. Папките с template.json или part.json са източници на Blockstudio; обикновените файлове .html до тях остават собствени шаблони на WordPress.

Изходният файл може да бъде index.php, index.blade.php, index.twig или index.html, проверени в този ред. Twig изисква Timber, а Blade изисква своя пакет за визуализация, както е описано в Енджини за шаблони.

Стъпка 1: Частта за хедъра

Всяка част се нуждае от part.json. area указва на редактора на сайта къде принадлежи частта:

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

Източникът използва същия синтаксис като страниците и шаблоните Blockstudio. Елемент <div> става групов блок, атрибутите стават атрибути на блока, а елементите <block> създават всеки регистриран блок:

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

Blockstudio го компилира до това маркиране на блокове:

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

Това е кодът, който иначе бихте написали на ръка. Собствените ви блокове работят по същия начин: <block name="acme/announcement" />, таг <bs:acme-announcement /> или конфигуриран префикс на таг се компилират до коментара за блока.

Една част може да се състои само от един абзац. Тази използва index.html, за да покаже, че източникът е маркиране, а не програма:

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

Компилира се до <!-- wp:paragraph --><p>Built with Acme.</p><!-- /wp:paragraph -->.

Стъпка 3: Шаблони за начална и единична страница

Шаблоните използват template.json. slug трябва да е точно име от йерархията на шаблоните WordPress, например front-page, single, page, archive, 404 или single-product. Blockstudio никога не го предхожда.

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

Шаблонът за единична публикация следва същата структура, но използва блокове за публикации:

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

Компилираният шаблон за единична публикация:

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> стана групов блок с tagName: "main", а блоковете за части на шаблона препращат към частите от стъпки 1 и 2 чрез slug. Когато WordPress визуализира шаблона, тези препратки се насочват към частите от файловете, така че изходът на началната страница започва с <header class="wp-block-template-part">, съдържащ заглавието на сайта и навигацията, и завършва с <footer class="wp-block-template-part">, съдържащ абзаца във футъра.

Стъпка 4: Персонализиран шаблон за страници

Шаблоните, чийто slug не е част от йерархията, са персонализирани шаблони. Посочете типовете публикации, за които важат, с postTypes, за да могат редакторите да ги избират от селектора за шаблони:

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' ) вече включва page-landing, а обектът на шаблона съдържа post_types: ["page"].

Източниците се компилират еднократно

Източникът се прочита и компилира до маркиране на блокове еднократно, а не при всяка заявка. Няма текуща публикация и контекст на заявката. index.php се чете като маркиране: кодът PHP в него не се изпълнява, затова <?php echo get_bloginfo( 'name' ); ?> се компилира до нищо. Всичко, което зависи от заявката, трябва да е в блок, който се визуализира по време на изпълнение: core/site-title вместо изведено име на сайта, core/post-title вместо the_title() или ваш собствен динамичен блок Blockstudio.

Компилираните резултати се кешират заедно с метаданните за наблюдение на файловете. Редактирането на манифест или изходен файл обезсилва кешираното съдържание за съответния елемент, така че следващата заявка вижда промяната без отделна стъпка за изграждане.

Как WordPress открива файловете

Blockstudio се включва в същите механизми за търсене, които WordPress използва за шаблоните на темата. В get_block_templates() шаблоните от файлове се появяват с source: "theme" и origin: "theme", точно като собствените файлове на темата, а get_block_template( 'acme//header', 'wp_template_part' ) връща частта за хедъра заедно с нейния area.

Редът на търсене е:

  1. Персонализация на редактора на сайта, съхранена в базата данни.
  2. Собствен файл .html в активната тема.
  3. Изходен файл Blockstudio.
  4. Резервни варианти от родителската тема или плъгините.

Този ред запазва работния процес в редактора на сайта. Когато потребител редактира футъра и запазва, WordPress съхранява публикация wp_template_part, а get_block_template() връща тази персонализация с source: "custom". По-късните промени в parts/footer/index.html не се показват, докато съществува персонализацията. Когато потребителят нулира частта или публикацията бъде изтрита, търсенето преминава към файла и отново връща последната компилирана версия на източника.

Blockstudio не записва редакциите от редактора на сайта обратно във файлове. Ако промяната на потребителя трябва да стане новата версия по подразбиране, копирайте я в изходния файл и нулирайте персонализацията.

Вложени index.html и slug стойности

WordPress открива рекурсивно файлове .html в templates/ и parts/. Затова папка с манифест, която използва index.html, например parts/footer/index.html, също би се показала като собствена част с формиран от пътя slug footer/index. Тъй като Blockstudio 7.6.6, част index.html с манифест се показва само под декларирания си slug, така че редакторът на сайта показва един футър, а не два. Вложените файлове .html без манифест не се променят.

Проверка на шаблони от PHP

Класът Blockstudio\Site_Templates чете и компилира източниците, което е полезно при тестове и проверки за внедряване:

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

Всеки елемент включва slug, title, description, type (wp_template или wp_template_part), status, source_type, postTypes за шаблони или area за части, meta и компилирания content. Подайте списък, за да компилирате само избрани елементи, и прочетете проблемите за този избор чрез selection_errors():

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

Добавяне на други папки

За да държите източниците Blockstudio отделно от собствените шаблони или да ги доставяте чрез плъгин, добавете коренови директории за откриване с филтри:

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

Филтрите blockstudio/site_templates/template_content и part_content коригират източника преди разчитането му, а blockstudio/site_templates/parser заменя разчитателя за един елемент. Пълният списък е в таблицата с куки за шаблони на сайта.

Кога да използвате всеки вариант

Искате Използвайте
Оформлението на темата, което WordPress избира за URL: хедър, футър, единична страница, архив Шаблони и части на сайта
Страница с URL адрес, чието съдържание се намира във файлове Страници от файлове
Повторно използваема секция, която редакторите вмъкват Шаблони

Шаблоните не създават публикации. Страниците го правят. Например секцията с документация е колекция от страници, чиито публикации се визуализират чрез шаблон, който все още можете да създавате тук.

Следващи стъпки