In den letzten Beiträgen zu dieser Artikelreihe ging es meistens um technische Anpassungen an Plugins. Heute möchte ich mich mit Änderungen an Template Dateien beschäftigen und an einem Beispiel zeigen, wie oft dies bei gute programmierten Plugins möglich ist.

Templates: Im Theme oder im Plugin?

Als Beispiel habe ich mir WooCommerce vorgenommen. Es war das erste Mal, dass ich es installiert habe und ich war recht beeindruckt, wie gut man durch die ersten Einrichtungsschritte geführt wird. Aber darum soll es ja heute nicht gehen.

Viele Plugins haben die Eigenschaft „Kompatibel mit WooCommerce“. Ein passendes Theme zu wählen, dass für die Darstellung von Shops erstellt wurde bietet sich auf jeden Fall an. Aber selbst mit dem TwentySixteen Theme konnte ich alle Schritte einer Bestellung durchgehen.

Wenn es nun um das Anpassen von Templates für WooCommerce geht, dann stellt sich natürlich die Frage, wieso man das in einem Plugin tun sollte und nicht besser im Theme. Das ist eine sehr berechtigte Frage und die Antwort ist: im Theme (oder noch besser Child Theme) ist eine solche Anpassung besser aufgehoben.

Aber dennoch kann es Anwendungsfälle geben, bei denen man ein Template aus einem Plugin für alle Themes überschreiben möchte, die dieses Plugin verwenden. Stehen diese Anpassungen nicht im Konflikt zu dem Theme, macht es durchaus Sinn, dies in einem Child Plugin zu tun.

Und außerdem brauchte ich einfach für den Artikel ein schönes Beispiel und da hat sich WooCommerce angeboten 🙂

Die WooCommerce Template-Suche

Wann immer WooCommerce eines seiner Templates rendert, sucht es standardmäßig an drei Orten und in der folgenden Reihenfolge:

1. In einem Unterordner im Child Theme
2. In einem Unterordner im Parent Theme
3. In einem Unterordner des WooCommerce Plugins

Wenn man also ein Template überschreiben möchte, kann man dieses ganz einfach dadurch tun, dass man einen Ordner /woocommerce/templates/ im Child Theme oder Parent Theme anlegt und darin die entsprechende Ordner- und Dateistruktur übernimmt. Das erste gefundene Template wird dann verwendet. Man sollte natürlich nur solche Templates kopieren, die man wirklich verändern möchte. Stichwort Child Theme Dilemma.

Die Template-Suche erweitern

Da WooCommerce nicht ebenfalls in allen Plugins nach der Template-Struktur sucht, müssen wir unseren Ordner selbst registrieren. Hierzu bietet es einen Filter an:

function my_custom_wc_locate_template( $template, $template_name, $template_path ) {

	$template_overwrite = dirname( __FILE__ ) .  '/templates/' . $template_name;

	if ( file_exists( $template_overwrite ) ) {
		$template = $template_overwrite;
	}

	return $template;
}

add_filter( 'woocommerce_locate_template', 'my_custom_wc_locate_template', 10, 3 );

Wir verwenden hier den Filter woocommerce_locate_template und versuchen darin, die gesuchte Template-Datei im Unterordner templates unseres Plugins zu finden. Das ist wirklich schon alles 🙂

Fazit

Wie ihr also sehen könnt, ist es bei einem gut programmierten Plugin sehr einfach, die Templates zu überschreiben. Ich habe genau dieser Technik auch schon bei Plugins wie BuddyPress oder einigen Premium Plugins verwenden könnten. Natürlich müsst ihr herausfinden, wie der entsprechende Filter dazu heißt. Ob nun das Überschreiben der Plugins wirklich in einem Plugin oder doch besser in einem (Child) Theme passiert, solltet ihr vorher gut überlegen. Und vergesst nicht, dass ihr eure kopierten Templates bei Updates des Plugins eventuell ebenfalls aktualisieren müsst.

Falls ihr bei einem Plugin bisher keinen Erfolg hattet, die Templates zu überschreiben, würde ich mich sehr über ein Beispiel freuen. Vielleicht findet sich ja hierfür ein anderer Trick. Eventuell ja der aus dem letzten Beitrag 😉

Weitere Artikel zu Themenreihe

Dies ist der sechste Teil der Themenreihe „Child Plugins“. Hier findest du die anderen Beiträge:

• Teil 1: Konstanten definieren um Plugins anzupassen
• Teil 2: Die Funktionsweise von Plugins mit Hooks anpassen
• Teil 3: Actions in Plugins finden oder selbst einbauen
• Teil 4: Filter in Plugins verwenden
• Teil 5: Plugins ohne Actions und Filter anpassen
• Teil 7: Zusammenfassung der Themenreihe