İçeriğe geç

Site Şablonları

Site Şablonları, blok temalarının WordPress wp_template ve wp_template_part kaynaklarını, Blockstudio sayfaları ve desenlerinde kullanılan dosya öncelikli söz dizimiyle tanımlamasını sağlar.

Site Şablonları, WordPress’in Site Düzenleyicisi şablon hiyerarşisi üzerinden seçtiği tema düzenini (ön sayfa, tekil yazılar, arşivler, arama, 404 sayfaları, üstbilgiler, altbilgiler ve diğer şablon parçaları) kontrol etmek istediğinizde kullanın.

Sayfalar, Desenler veya Site Şablonları?

Özellik Oluşturur En uygun kullanım
Sayfalar Yazılar veya özel yazı türü girdileri Gerçek içerik sayfaları, dokümantasyon sayfaları, açılış sayfaları ve yönlendirilebilir içerikler.
Desenler Blok desenleri Düzenleyicilerin eklediği yeniden kullanılabilir bölümler.
Site Şablonları wp_template ve wp_template_part dosya kaynakları Site Düzenleyicisi ve WordPress şablon hiyerarşisinin kontrol ettiği tema düzeni.

Site Şablonları normal sayfalar oluşturmaz. Blok teması şablonunu çözümlerken WordPress tarafından kullanılan dosya kaynağını sağlar. Kullanıcı Site Düzenleyicisi’nde şablonu özelleştirirse, WordPress bu özelleştirmeyi veritabanında saklar ve sıfırlanana kadar dosya kaynağına üstün gelir.

Klasör Yapısı

Tam şablonları templates/ dizinine, şablon parçalarını parts/ dizinine yerleştirin:

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

Her klasörde bir manifest ve bir kaynak dosyası bulunur.

Dosya Motor
index.php HTML benzeri blok işaretlemesi, olduğu gibi okunur (PHP kodu çalıştırılmaz)
index.blade.php Blade
index.twig Twig
index.html HTML benzeri blok işaretlemesi

Birden çok kaynak dosyası varsa, Blockstudio şu sırayı kullanır:

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

WordPress ayrıca .html dosyalarını yinelemeli olarak bulur ve genellikle iç içe geçmiş bir index.html öğesini, header/index gibi yolundan türetilen slug altında sunar. Bu dosya bir Blockstudio manifestine ait olduğunda Blockstudio, yoldan türetilen yinelenen öğeyi kaldırır ve yalnızca manifestte tanımlanan slug öğesini sunar. Blockstudio manifesti olmayan iç içe yerel .html şablonları değişmeden kalır.

Kaynak bir kez yerel WordPress blok işaretlemesine derlenir. Geçerli isteğe veya yazıya bağlı olmamalıdır. Çalışma zamanı davranışını dinamik blokların içine yerleştirin.

template.json

template.json, tam bir Site Düzenleyicisi şablonu tanımlar.

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

Özellikler

Özellik Tür Varsayılan Açıklama
slug / name string Klasör adı WordPress şablon kısa adı. front-page, single, archive-product veya 404 gibi tam hiyerarşi kısa adlarını kullanın.
title string Kısa addan başlık Site Düzenleyicisi’nde görünen başlık.
description string "" Site Düzenleyicisi’nde gösterilen açıklama.
postTypes string[] [] Özel şablonlar için yazı türleri. Çekirdek hiyerarşi şablonlarında bu alan boş bırakılabilir.
source / template / file string Otomatik algılanan dizin dosyası Şablon klasörüne göreli isteğe bağlı kaynak dosyası yolu.
status string "publish" Şablon durumu.
sync boolean false Gelecekte veritabanına dönüştürme için ayrılmıştır. Kullanıcı özelleştirmelerinin üzerine v1 içinde hiçbir zaman yazılmaz.
meta object {} Yardımcı API’ler için özel meta veriler. Bilinmeyen manifest anahtarları da burada saklanır.

Şablon kısa adlarına önek eklenmez. Şablon hiyerarşisi için WordPress tam adlara ihtiyaç duyar:

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, Site Düzenleyicisi şablon parçasını tanımlar.

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

Özellikler

Özellik Tür Varsayılan Açıklama
slug / name string Klasör adı WordPress şablon parçası kısa adı.
title string Kısa addan başlık Site Düzenleyicisi’nde görünen başlık.
description string "" Site Düzenleyicisi’nde gösterilen açıklama.
area string "uncategorized" Şablon parçası alanı. Yaygın değerler header, footer ve sidebar şeklindedir.
source / template / file string Otomatik algılanan dizin dosyası Parça klasörüne göreli isteğe bağlı kaynak dosyası yolu.
status string "publish" Şablon parçası durumu.
meta object {} Yardımcı API’ler için özel meta veriler. Bilinmeyen manifest anahtarları da burada saklanır.

İşaretleme Yazımı

Site Şablonu kaynakları, sayfalar ve desenlerle aynı ayrıştırıcıyı kullanır:

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> öğesi, core/group bloğuna dönüşür ve <main> olarak görüntülenir; core/post-content blok etiketi de dahil olmak üzere alt öğeleri ise iç bloklarına dönüşür. Şunları kullanabilirsiniz:

  • <h1>, <p>, <ul>, <div> gibi standart HTML öğeleri ve <main>, <header>, <footer>, <article> ve <aside> gibi bölümleme öğeleri
  • <block name="namespace/block">
  • <bs:namespace-block>
  • yapılandırılmış blok etiketi önekleri
  • Blockstudio blokları ve bileşenleri

WordPress derlenen şablonu işlerken şablon parçası blokları etkin tema özniteliğini alır.

Site Düzenleyicisi Özelleştirmeleri

Blockstudio dosya kaynağını sağlar. Kullanıcı özelleştirmelerinin kontrolü WordPress’dedir.

Arama sırası şöyledir:

  1. Site Düzenleyicisi veritabanı özelleştirmesi
  2. Yerel etkin tema .html dosyası
  3. Blockstudio dosya tabanlı kaynak
  4. Üst tema veya eklenti yedek kaynakları

Kullanıcı, Site Düzenleyicisi’nde Blockstudio dosya tabanlı bir şablonu kaydettiğinde, WordPress normal bir wp_template veya wp_template_part veritabanı girdisi oluşturur. Kaydedilen bu girdi, gelecekteki dosya değişikliklerine üstün gelir. Özelleştirme sıfırlandığında veya silindiğinde en güncel dosya tabanlı kaynak yeniden görünür.

Blockstudio, Site Düzenleyicisi düzenlemelerini v1 içindeki dosyalara geri yazmaz.

Performans

Şablon keşfi istek başına önbelleğe alınır ve dosya izleme meta verileriyle kalıcı olarak saklanır. Bir manifest veya kaynak dosyası değiştiğinde derlenmiş içerik önbelleği geçersiz kılınır. Veritabanı özelleştirmeleri önbelleğe alınmaz: WordPress bunları yine ilk olarak kontrol eder.

Birden çok kökten dosya oluşturan çalışma zamanı entegrasyonları, şablonlar ve şablon parçaları için bir mantıksal keşif kaynağı sağlayabilir. Manifestler ve seçilen kaynak şablonları, tek bir mantıksal tema ağacını korurken farklı fiziksel köklerde bulunabilir.

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

Yalnızca tam kısa adları, yolları veya kaynak yollarını okuyup derlemek için açık bir liste aktarın:

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

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

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

Bağımsız değişkeni atlamak, kayıt defterinin tüm davranışlarını korur. Boş liste aktarıldığında hiçbir öğe döndürülmez. Geleneksel kısa ad ve yol istekleri keşfi eşleşen dizinlerle sınırlar; özel manifest kısa adları meta veri taraması gerektirebilir, ancak ilgisiz kaynaklar derlenmez veya döndürülmez.

Şablon yardımcı işlevleri de kullanılabilir:

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

Kancalar

Site Şablonlarının tüm genişletme noktaları şunlardır:

Kanca Tür Açıklama
blockstudio/site_templates/template_paths Filtre Tam şablon keşif köklerini ayarlar.
blockstudio/site_templates/part_paths Filtre Şablon parçası keşif köklerini ayarlar.
blockstudio/site_templates/paths Filtre Her iki yol listesini templates ve parts olarak ayarlar.
blockstudio/site_templates/template_candidates Filtre Bir manifest için kaynak dosyası adaylarını ayarlar.
blockstudio/site_templates/templates Filtre Kayıt defterinin API tarafından döndürülen şablonları ayarlar.
blockstudio/site_templates/parts Filtre Kayıt defterinin API tarafından döndürülen şablon parçalarını ayarlar.
blockstudio/site_templates/template_content Filtre Ayrıştırma öncesinde derlenen tam şablon kaynağını ayarlar.
blockstudio/site_templates/part_content Filtre Ayrıştırma öncesinde derlenen şablon parçası kaynağını ayarlar.
blockstudio/site_templates/parser Filtre Tek bir öğe için Html_Parser örneğini değiştirir.
blockstudio/site_templates/source_compiled Eylem Seçilen bir kaynak derlenmeden hemen önce çalışır.
blockstudio/site_templates/discovered Eylem Soğuk keşif ve derleme geçişinden sonra çalışır.
blockstudio/site_templates/registered Eylem Yeniden oluşturulan kayıt defteri kalıcı olarak saklandıktan sonra çalışır.

Keşif yollarını ekleyin veya değiştirin:

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

Keşfedilen verileri filtreleyin:

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

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

Ayrıştırmadan önce kaynağı filtreleyin:

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

Kaynak adaylarını veya ayrıştırıcıyı değiştirin:

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 ve registered, önbellek yeniden oluşturma yaşam döngüsü eylemleridir. Sıcak kayıt defteri önbelleği isabetinde çalışmazlar.