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

Шаблони на сайта

Шаблоните на сайта позволяват на блоковите теми да дефинират източници на WordPress wp_template и wp_template_part със същия синтаксис с приоритет на файловете, използван за страниците и шаблоните на Blockstudio.

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

Страници, шаблони или шаблони на сайта?

Функция Създава Най-подходящо за
Страници Публикации или записи от персонализиран тип публикация Страници със съдържание, страници с документация, целеви страници и съдържание с отделен маршрут.
Шаблони Модели на блокове Секции за многократна употреба, вмъквани от редакторите.
Шаблони на сайта Файлови източници wp_template и wp_template_part Оформление на темата, контролирано от редактора на сайта и йерархията на шаблоните WordPress.

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

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

Поставете пълните шаблони в templates/, а частите на шаблони — в 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

Всяка папка съдържа манифест и един изходен файл.

Файл Механизъм
index.php Блоков код, подобен на HTML, който се чете както е (кодът на PHP не се изпълнява)
index.blade.php Blade
index.twig Twig
index.html Блоков код, подобен на HTML

Ако има няколко изходни файла, Blockstudio използва следния ред:

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

WordPress открива рекурсивно и файлове .html и обикновено предоставя вложен index.html под генериран от пътя идентификатор, например header/index. Когато този файл принадлежи на манифест Blockstudio, Blockstudio премахва дублиращия се елемент, генериран от пътя, и предоставя само slug, деклариран в манифеста. Вложените вградени шаблони .html без манифест Blockstudio остават непроменени.

Източникът се компилира еднократно в собствен блоков код WordPress. Той не трябва да зависи от текущата заявка или публикация. Поставяйте поведението по време на изпълнение в динамични блокове.

template.json

template.json дефинира пълен шаблон за редактора на сайта.

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

Свойства

Свойство Тип По подразбиране Описание
slug / name string Име на папката WordPress идентификатор на шаблона. Използвайте точни идентификатори от йерархията, като front-page, single, archive-product или 404.
title string Заглавие от идентификатора Показвано заглавие в редактора на сайта.
description string "" Показвано описание в редактора на сайта.
postTypes string[] [] Типове публикации за персонализирани шаблони. Основните шаблони на йерархията може да не включват това.
source / template / file string Автоматично открит индексен файл Незадължителен път към изходния файл спрямо папката на шаблона.
status string "publish" Състояние на шаблона.
sync boolean false Запазено за бъдещо материализиране в базата данни. Потребителските персонализации никога не се презаписват в v1.
meta object {} Персонализирани метаданни за помощните API. Неизвестните ключове в манифеста също се съхраняват тук.

Идентификаторите на шаблоните нямат префикс. WordPress се нуждае от точни имена за йерархията на шаблоните:

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 дефинира част от шаблон за редактора на сайта.

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

Свойства

Свойство Тип По подразбиране Описание
slug / name string Име на папката WordPress идентификатор на частта от шаблона.
title string Заглавие от идентификатора Показвано заглавие в редактора на сайта.
description string "" Показвано описание в редактора на сайта.
area string "uncategorized" Област на частта от шаблона. Обичайните стойности са header, footer и sidebar.
source / template / file string Автоматично открит индексен файл Незадължителен път към изходния файл спрямо папката на частта.
status string "publish" Състояние на частта от шаблона.
meta object {} Персонализирани метаданни за помощните API. Неизвестните ключове в манифеста също се съхраняват тук.

Създаване на код

Източниците на шаблони на сайта използват същия парсер като страниците и шаблоните:

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>

Елементът <main> става блок core/group, който се визуализира като <main>, а дъщерните му елементи, включително маркерът на блок core/post-content, стават вътрешни блокове. Можете да използвате:

  • стандартни елементи HTML, като <h1>, <p>, <ul>, <div> и елементите за структуриране на секции <main>, <header>, <footer>, <article> и <aside>
  • <block name="namespace/block">
  • <bs:namespace-block>
  • конфигурирани префикси за маркери на блокове
  • блокове и компоненти Blockstudio

Блоковете за части от шаблони получават атрибута на активната тема, когато WordPress визуализира компилирания шаблон.

Персонализации в редактора на сайта

Blockstudio предоставя файловия източник. WordPress съхранява потребителските персонализации.

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

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

Когато потребител запише шаблон, базиран на файл Blockstudio, в редактора на сайта, WordPress създава обикновен запис wp_template или wp_template_part в базата данни. Този запис има предимство пред бъдещите промени във файловете. При нулиране или изтриване на персонализацията отново става видим най-новият файлов източник.

Blockstudio не записва редакциите от редактора на сайта обратно във файловете в v1.

Производителност

Откриването на шаблони се кешира за всяка заявка и се запазва заедно с метаданните за наблюдение на файловете. При промяна на манифест или изходен файл кешираното компилирано съдържание се обезсилва. Персонализациите в базата данни не се кешират; WordPress продължава да ги проверява първо.

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

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

Предайте изричен списък, за да четете и компилирате само точни идентификатори, пътища или изходни пътища:

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

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

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

Ако пропуснете аргумента, поведението на целия регистър се запазва. Предаването на празен списък не връща елементи. Обичайните заявки за идентификатор или път ограничават откриването до съответните директории; за персонализирани идентификатори от манифеста може да е необходимо сканиране на метаданните, но несвързаните източници пак няма да бъдат компилирани или върнати.

Налични са и помощни функции за шаблони:

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

Куки

Пълният набор от разширения за шаблони на сайта е:

Hook Тип Описание
blockstudio/site_templates/template_paths Филтър Настройва корените за откриване на пълни шаблони.
blockstudio/site_templates/part_paths Филтър Настройва корените за откриване на части от шаблони.
blockstudio/site_templates/paths Филтър Настройва и двата списъка с пътища като templates и parts.
blockstudio/site_templates/template_candidates Филтър Настройва кандидатите за изходни файлове за даден манифест.
blockstudio/site_templates/templates Филтър Настройва шаблоните, връщани от API на регистъра.
blockstudio/site_templates/parts Филтър Настройва частите на шаблони, връщани от API на регистъра.
blockstudio/site_templates/template_content Филтър Настройва източника на компилиран пълен шаблон преди парсване.
blockstudio/site_templates/part_content Филтър Настройва източника на компилирана част от шаблон преди парсване.
blockstudio/site_templates/parser Филтър Заменя екземпляра на Html_Parser за един елемент.
blockstudio/site_templates/source_compiled Действие Изпълнява се непосредствено преди компилиране на един избран източник.
blockstudio/site_templates/discovered Действие Изпълнява се след преминаване за откриване и компилиране без кеш.
blockstudio/site_templates/registered Действие Изпълнява се след запазване на повторно изграден регистър.

Добавяне или замяна на пътища за откриване:

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

Филтриране на откритите данни:

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

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

Филтриране на източника преди парсване:

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

Промяна на кандидатите за източник или парсера:

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 и registered са действия от жизнения цикъл при повторно изграждане на кеша. Те не се изпълняват при попадение в кеша на вече изграден регистър.