JPKCom DB
Auf GitHub ansehen (öffnet in neuem Tab)

JPKCom Theme is LiveCanvas friendly — Anleitung & Tipps

Ein beliebiges WordPress-Theme als LiveCanvas-kompatibel kennzeichnen — Installation, Bootstrap-Version und das nötige Empty-Page-Template.

JPKCom Theme is LiveCanvas friendly meldet LiveCanvas (öffnet in neuem Tab), dass dein aktives Theme LiveCanvas-kompatibel ist. Das Plugin stellt die Helper-Funktionen lc_theme_is_livecanvas_friendly() und lc_theme_bootstrap_version() bereit, sodass du dein Theme nicht selbst um diese Funktionen erweitern musst.

Anleitung

Voraussetzungen

  • WordPress 6.9 oder neuer (getestet bis WordPress 7.1)
  • PHP 8.3 oder neuer
  • Das Plugin LiveCanvas (im Header als Requires Plugins: livecanvas ausgewiesen) muss aktiv sein

Installation

  1. Gehe im Admin-Bereich zu Plugins → Installieren und klicke auf Plugin hochladen.
  2. Wähle die ZIP-Datei des Plugins und klicke auf Jetzt installieren.
  3. Stelle sicher, dass das LiveCanvas-Plugin aktiviert ist.
  4. Klicke auf Aktivieren.
  5. Lege in deinem Theme-Ordner ein Unterverzeichnis page-templates an.
  6. Erstelle darin eine Datei empty.php mit folgendem Inhalt:
php
<?php
/* Template Name: Empty */

defined( 'ABSPATH' ) || exit;

get_header();

while ( have_posts() ) :
the_post();
the_content();
endwhile;

get_footer();

Bootstrap-Version

lc_theme_bootstrap_version() teilt LiveCanvas mit, welche Bootstrap-Version dein Theme nutzt. Laut README-Beispiel gibt die Funktion 5.3 für aktuelles Bootstrap zurück; alternativ sind 5 (Bootstrap 5.0–5.2) oder 4 (Bootstrap 4) möglich.

Tipps & Tricks

  • Das Empty-Template ist Pflicht: Ohne das page-templates/empty.php in deinem Theme fehlt LiveCanvas die leere Vorlage, auf der es seine Inhalte aufbaut. Lege es genau wie im README gezeigt an.
  • Helfer sind abgesichert: Ab Version 1.0.4 sind die LiveCanvas-Helper-Funktionen mit function_exists() geschützt — sie kollidieren also nicht, falls dein Theme dieselben Funktionen schon definiert.
  • Bootstrap-Version anpassen: Passe den Rückgabewert von lc_theme_bootstrap_version() an die tatsächlich von deinem Theme verwendete Bootstrap-Version an.
  • Reproduzierbare Updates: Ab Version 1.0.4 nutzt das Plugin sichere, selbst gehostete Updates über GitHub mit SHA256-Prüfsummen und arbeitet mit declare(strict_types=1). Seit 1.0.10 trägt es außerdem den Header Update URI: Die Update-Schnittstelle von wordpress.org liefert für dieses Plugin dann keine Updates mehr, ein dort veröffentlichtes Plugin mit demselben Slug kann sich also nicht als Update ausgeben. Seit 1.0.11 zeigt Dashboard → Aktualisierungen das JPKCom-Logo als Plugin-Icon.
  • Updates auch im deaktivierten Zustand: Seit 1.0.12 bringt das Plugin Updater 1.5.0 mit. Ein geladener Updater 1.5.0 beantwortet die Update-Abfrage für alle installierten JPKCom-Plugins, aktiv oder nicht, samt Update-Zeile, Icon und „Details anzeigen“ — dieses Plugin bekommt Updates im deaktivierten Zustand also nur angeboten, wenn ein anderes JPKCom-Plugin mit Updater 1.5.0 oder neuer aktiv ist, auf Multisite netzwerkweit oder auf der Hauptseite. Die SHA256-Prüfung gilt dabei genauso wie für ein aktives Plugin. Die gespeicherte Update-Liste enthält keine JPKCom-Download-Adressen mehr; sie kommen nur zurück, solange ein JPKCom-Updater geladen ist, sodass sich ohne ihn kein ungeprüftes Paket installieren lässt. Die Prüfung verifiziert außerdem Pakete, die ein anderes Plugin bereitstellt, und erkennt jede GitHub-Adresse einer Release-Datei. Liegt das Plugin als Git- oder anderer Versionskontroll-Checkout vor oder, solange es aktiv ist, in einem umbenannten Ordner (etwa jpkcom-is-lc-friendly-main aus einem GitHub-Quellcode-Download), erfährst du von neuen Versionen, WordPress aktualisiert es aber nie — das Update würde den Checkout bzw. den Ordner löschen. Liegt es deaktiviert in einem umbenannten Ordner, findet der Updater es gar nicht, und du erfährst nichts von neuen Versionen. Update-Infos holt der Updater nur für Konten, die Plugins aktualisieren dürfen, im Update-Cron und in WP-CLI, nie für anonyme Besucher.

Weiterführende Informationen