Templating

Grundlagen #

Zur Bearbeitung von PHP-Templates benötigst – abhängig von deinem Vorhaben – Kenntnisse im Bereich HTML, CSS und PHP. Darüber hinaus ist es empfehlenswert, einen Editor wie Notepad++ (Windows) oder Sublime Text (MacOS) zu verwenden.

Hinweis: Bitte niemals Änderungen innerhalb des Plugin-Verzeichnisses vornehmen, da diese sonst beim nächsten Update überschrieben werden!

Bestehende Templates anpassen #

Um ein bestehendes Template nach deinen Wünschen anzupassen, gehst du wie folgt vor:

1. Erstelle in deinem Theme/Child-Theme einen neuen Unterordner “aawp”
2. Kopiere aus dem Plugin-Verzeichnis (Unterordner “templates”) die Template-Datei, welche du anpassen möchtest
3. Füge die Datei aus Punkt 2, in den zuvor (Punkt 1) erstellten Unterordner ein
4. Achte darauf, dass du die Ordner-Struktur aus dem Plugin-Verzeichnis widerspiegelst:
   • aus Plugin-Verzeichnis “/templates/table.php” wird dann im Theme-Verzeichnis “/aawp/table.php“
   • aus Plugin-Verzeichnis “/templates/products/vertical.php” wird dann im Theme-Verzeichnis “/aawp/products/vertical.php“
   • etc…
5. Die Datei in deinem Theme kannst du nun beliebig bearbeiten und …
   • das HTML-Gerüst ändern
   • CSS-Klassen ändern oder hinzufügen
   • nicht benötigte Elemente (z.B. Beschreibung) entfernen oder verschieben
   • etc…
6. Ab sofort wird das Plugin, statt dem mitgelieferten Template, dein angepasstes Template zur Ausgabe verwenden

Neue Templates erstellen #

Du hast nicht nur die Möglichkeit, bestehende Templates zu überschrieben, sondern ebenfalls eigene Templates zu erstellen. Dies macht besonders Sinn, wenn du eine komplett eigene Darstellung erreichen möchtest, die zusätzlich zu den bereits bestehenden verwendet werden soll.

Um ein neues Template anzulegen, gehst du am Besten wie folgt vor:

1. Erstelle in deinem Theme/Child-Theme einen neuen Unterordner “aawp”
2. Kopiere aus dem Plugin-Verzeichnis (Unterordner “templates”) die Template-Datei, welche dir als Vorlage für dein eigenes Template dienen soll
3. Füge die Datei aus Punkt 2, in den zuvor (Punkt 1) erstellten Unterordner ein
4. AAWP sucht sich die Templates entsprechend folgender Logik aus dem Verzeichnis heraus:
   • zuerst wird im Unterordner /products/ geschaut, ob es sich um das Template eines einzelnen Produktes handelt
   • falls nicht, wird im Hauptverzeichnis geschaut, ob es sich um ein Layout (z.B. “table”) handelt
   • je nach Anwendungsfall kann entweder nur das einzelne Produkt-Template ersetzt, oder einfach das Produkt-Template direkt ins Layout-Template eingefügt werden
5. Achte darauf, dass du dementsprechend folgende Ordner-Struktur widerspiegelst:
   • wenn du nur eine neue Produktbox erstellen willst, dann lege das Template in das Theme-Verzeichnis “/aawp/products/my-box.php“
   • wenn du auch das Gerüst drum herum ändern willst, dann lege das Template in das Theme-Verzeichnis “/aawp/my-box.php” (in diesem Fall musst du dir ggfls. noch aus dem entsprechenden Layout-Template den ein oder anderen Code heraussuchen)
   • Weitere Informationen dazu findest du in der Dokumentation der Templates
6. Die Datei in deinem Theme kannst du nun beliebig bearbeiten und …
   • das HTML-Gerüst ändern
   • CSS-Klassen ändern oder hinzufügen
   • nicht mehr benötigte Elemente (z.B. Beschreibung) entfernen oder andere wiederum an eine andere Position verschieben
   • etc…
7. Das neu erstellte Template kann nun entweder in den Plugin-Einstellungen (Reiter “Funktionen”) fest vorgegeben, oder per Shortcode ausgewählt werden (siehe Funktionen – Plugin Einstellungen)

Templates, die wie zuvor geschildert im Theme/Child-Theme Unterordner “aawp” liegen, werden bei einem Update seitens AAWP nicht überschrieben.

Hinweis: Bei künftigen Updates empfiehlt es sich, in den Changelog zu schauen, ob die mitgelieferten Templates aktualisiert oder sogar funktional erweitert wurden. In diesem Fall müsstest du das aktualisierte Template mit deinem eigenen vergleichen und letzteres ggfls. anpassen.