Μετάβαση στο περιεχόμενο

Πρότυπα και τμήματα του Επεξεργαστή ιστότοπου από αρχεία

Ένα θέμα μπλοκ περιγράφει τη διάταξή του στα templates/*.html και parts/*.html: αρχεία γεμάτα σειριοποιημένα σχόλια μπλοκ, όπως το <!-- wp:template-part {"slug":"header"} /-->. Κανείς δεν απολαμβάνει να τα γράφει με το χέρι, γι’ αυτό συνήθως τα δημιουργούν στον Επεξεργαστή ιστότοπου και τα εξάγουν. Αυτό λειτουργεί μέχρι να επεξεργαστούν δύο άτομα το ίδιο πρότυπο ή να χρειαστεί κάποιος αξιολογητής να διαβάσει μια διαφορά με διαφυγμένα JSON σε σχόλια HTML.

Το Blockstudio σάς επιτρέπει να γράφετε τα ίδια πρότυπα όπως γράφετε σελίδες που βασίζονται σε αρχεία: έναν φάκελο με ένα μικρό manifest JSON και ένα αρχείο πηγαίου κώδικα με σήμανση τύπου HTML, χρησιμοποιώντας απλά στοιχεία, ετικέτες <block> και τα δικά σας μπλοκ Blockstudio. Το Blockstudio μεταγλωττίζει τον πηγαίο κώδικα σε εγγενή σήμανση μπλοκ και τον παραδίδει στο WordPress ως αρχείο θέματος. Ο Επεξεργαστής ιστότοπου εξακολουθεί να λειτουργεί όπως πριν: οι χρήστες μπορούν να προσαρμόσουν ένα πρότυπο και, όταν το επαναφέρουν, επανέρχεται η έκδοση από το αρχείο.

Αυτός ο οδηγός δημιουργεί ένα τμήμα κεφαλίδας και υποσέλιδου, πρότυπα αρχικής σελίδας και μεμονωμένων δημοσιεύσεων, καθώς και ένα προσαρμοσμένο πρότυπο που μπορούν να επιλέγουν οι συντάκτες για σελίδες, και στη συνέχεια δείχνει πώς το WordPress τα εντοπίζει.

Δομή φακέλων

Τα πρότυπα τοποθετούνται στο templates/ και τα τμήματα προτύπων στο parts/. Κάθε στοιχείο είναι ένας φάκελος με manifest και ένα αρχείο πηγαίου κώδικα:

Κώδικας
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 για ένα θέμα μπλοκ. Το 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.

Τα μεταγλωττισμένα αποτελέσματα αποθηκεύονται στην κρυφή μνήμη μαζί με μεταδεδομένα παρακολούθησης αρχείων. Η επεξεργασία ενός αρχείου manifest ή πηγαίου κώδικα ακυρώνει το αποθηκευμένο περιεχόμενο για το συγκεκριμένο στοιχείο, οπότε το επόμενο αίτημα εμφανίζει την αλλαγή χωρίς ξεχωριστό βήμα δημιουργίας.

Πώς το 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/. Ένας φάκελος manifest που χρησιμοποιεί το index.html, όπως το parts/footer/index.html, θα εμφανιζόταν επομένως και ως εγγενές τμήμα με slug που προκύπτει από τη διαδρομή, το footer/index. Επειδή το Blockstudio 7.6.6, ένα index.html που ανήκει σε manifest εμφανίζεται μόνο με το δηλωμένο slug του, οπότε ο Επεξεργαστής ιστότοπου εμφανίζει ένα υποσέλιδο και όχι δύο. Τα ένθετα αρχεία .html χωρίς manifest δεν τροποποιούνται.

Έλεγχος προτύπων από το 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 αντικαθιστά τον αναλυτή για ένα στοιχείο. Η πλήρης λίστα βρίσκεται στον πίνακα hooks των προτύπων ιστότοπου.

Πότε να χρησιμοποιήσετε κάθε τύπο

Αυτό που θέλετε Χρησιμοποιήστε
Η διάταξη θέματος που επιλέγει το WordPress για ένα URL: κεφαλίδα, υποσέλιδο, μεμονωμένη δημοσίευση, αρχείο Πρότυπα και τμήματα ιστότοπου
Σελίδα με διαδρομή που αντλεί το περιεχόμενό της από αρχεία Σελίδες βάσει αρχείων
Επαναχρησιμοποιήσιμη ενότητα που εισάγουν οι συντάκτες Μοτίβα

Τα πρότυπα δεν δημιουργούν δημοσιεύσεις. Οι σελίδες το κάνουν. Για παράδειγμα, μια ενότητα τεκμηρίωσης είναι μια συλλογή σελίδων, οι δημοσιεύσεις της οποίας αποδίδονται μέσω ενός προτύπου που μπορείτε και πάλι να συντάξετε εδώ.

Επόμενα βήματα