Überdenke die Verwendung von Code Snippets! So lautet der Titel des Beitrages von Frank Bueltge, ein in der Blogosphäre bekannter Blogger, der aktiv bei der Entwicklung von WordPress mitarbeitet. Zudem ist er Verfasser von Büchern über WordPress und stellt auf sein Weblog den Lesern WordPress-Tipps und Plug-Ins kostenlos zur Verfügung. Er fordert ein Überdenken oder sogar Umdenken bei der Nutzung und Entwicklung von Code-Snippets. Die Arbeit, die dahinter steckt, sogenannte Code-Snippets zu entwerfen, weiterzuentwickeln und zu übersetzen sowie zu den von Ihm erstellten Code-Snippets Support zu leisten, wird oft verkannt und umso ärgerlicher ist es, wenn seine Veröffentlichungen missbraucht oder nur gedankenlos übernommen werden.

Die Idee

Die Idee Code-Snippets für interessierte Leser zur Verfügung zu stellen ist gerade für unerfahrene Websitebetreiber eine gute Sache. Funktion oder Problem auf Google gesucht und prompt findet man die »Lösung« in einem Code-Snippet auf Frank sein Blog. Sehr schön. Nun wird dieser Code, ohne dass der User weiß, was man tut, einfach in die jeweiligen Dateien kopiert und fertig. So handeln bestimmt viele Menschen, die sich in der Materie mit PHP und MySQL nicht auskennen (können). Aber auch erfahrene Administratoren verwenden diese Code-Snippets für ihre Website, beschweren sich aber unter Umständen, dass dieser Code nicht die erwartete 100%ige Lösung brachte. Und genau hier setzt Frank mit seinem Artikel an.

Ein Zitat bei einem Kommentar von Frank lautet:

[...] viele Wege führen nach Rom, aber man muss das Rad nicht neu erfinden, man muss nur wissen, wie man es nutzt und das ist ja der größte Benefiz der WP-Community.
Frank Bueltge

Folgen

Unüberlegtes kopieren der Code-Snippets in wichtige Dateien des WordPress-Systems kann ungeahnte Folgen mit sich bringen. Wenn nach keiner klaren Struktur bei der Arbeit am WordPress-System gehandelt wird und das vorher zu erstellende Backup vergessen wird, dann ist hinterher das Gejammer groß, wenn es nicht wie gewollt funktionierte nun nicht weiß, wie man es wieder rückgängig oder besser machen kann. Ein kleiner Wink an die Copy/Paste-Kultur von Snippets:

Trenne sauber zwischen den Funktionen für das Theme und der Nutzung des Code-Snippets als Erweiterung für das Gesamtsystem mittels eines Plug-Ins.

Nicht nur einfach anwenden

Ein Code-Snippet soll oder kann nicht die endgültige Lösung sein, da es viel zu viele Faktoren gibt, die das Ergebnis beeinflussen können. Es soll vielmehr als eine Basis betrachtet werden um ein bestimmtes Ziel erreichen zu können. Der Mensch, der die Code-Snippets verwendet, sollte wissen was er tut. Erst Recht, wenn man es mit Kunden zu tun hat und die Arbeit bezahlt wird. Was mich besonders ärgert sind die Menschen, welche Code-Snippets von anderen an Kunden weitergeben und diese als ihre eigenen ausgeben in der Hoffnung, das schon alles gut wird, hauptsache die Kohle stimmt…

Weißt Du was Du tust?

Man sollte wissen, was man tut, wenn am System gebastelt wird! Das kann ich nicht laut genug sagen. Doch wie kommt man nun an das Wissen?
Wie viele andere unerfahrene Nutzer der Code-Snippets auch, verwendete ich das oben angesprochene Vorgehen mit der Google-Suche. Von WordPress hatte ich bis dato wenig gehört und Programmiersprachen wie PHP und SQL-Datenbanken gehörten nicht zu meinen täglichen Gebrauch.
In meinen Beiträgen eine Website erstellen – Eine Odyssee in mehreren Schritten beschrieb ich meinen Weg von der Überlegung eine Webseite anhand einer Vorlage ohne weitere Kenntnisse zu erstellen bis zu der nun vorhanden Webseite, welche an vielen Stellen bearbeitet, neu erstellt oder optimiert wurde.
Vielen Dank an die Anbieter von Code-Snippets!

Möglich war dieser Weg aber nur weil ich nicht geistlos den Code nutzte und fertig. Es war/ist mir wichtig zu wissen, was genau im Code-Snippet passiert. Wieso wurde diese Funktion aufgerufen was bewirkt diese bestimmte Code-Zeile…?
Allein schon von meinem Ehrgeiz heraus versuchte ich, die Code-Snippets zu verifizieren. Was sind die Erfahrungen anderer Blogger mit diesem »Schnipsel«. Gibt es eine andere Lösung. Hat vielleicht jemand anders den Code auf seiner Website veröffentlicht, mit einer speziellen Beschreibung oder gar ein Tutorial verfasst?
Je mehr ich mich mit dem Code beschäftigte, desto sicherer fühlte ich mich auch mit dem Umgang des Quellcodes.
Jetzt sind zwar kein Crack in der Programmiersprache PHP und auch kein Spezialist im Umgang mit Abfragen an der Datenbank in Textform. Dennoch kann ich nun mit Stolz behaupten, dass ich weitestgehend weiß, was passiert, wenn bei der SQL-Abfrage ein Punkt oder Komma gesetzt wird oder bei PHP eine »while-Schleife« gesetzt ist.

Eigene Code-Snippets

Frank selbst schreibt, das er heute einige Code-Snippets oder Plug-Ins anders schreiben würde, einfach weil er mehr dazu gelernt hat und, wie ich denke, es auch weitere Möglichkeiten im Code von WordPress gibt. Eine gute Quelle ist hier immer die Codex-Seite von WordPress. Wenn ich soweit bin, werde ich auch WordPress-Themes oder Plug-Ins erstellen. Nur bei der derzeitigen Updatefolge von WordPress ist es gerade für Entwickler schwierig und auch zeitaufwendig, den Code an das neue System anzupassen.
Aus diesem Grund wäre es wünschenswert, auch für die Community, gemeinsam an Code-Snippets zu arbeiten und diese auch besser zu beschreiben, damit auch für weitere User die Möglichkeit besteht den Code zu verstehen und später vielleicht sogar am Prozess der Entwicklung mitwirken können!
Meiner Meinung nach können nur so eigene Fehler ausgemerzt und die Qualität der Code-Snippets und auch somit die Stabilität des WordPress-Systems gesteigert werden.

Prüfe den Code bei neuen Versionen

Es gibt viele Blogger, die Code-Snippets auf ihrem Blog veröffentlichen. Jetzt, wo WordPress 3.2 vor der Haustür steht, sollten die vorhanden Code-Schnipsel neu geprüft und unter Umständen überarbeitet werden. Es gibt viele User, die nun mit WordPress beginnen und mit Tipps zu WordPress 2.3 nicht viel anfangen können. Soll ich diesen Code-Snippet nun für WordPress 3.2 verwenden oder nicht. Genauso verhält es sich auch bei den Plug-Ins für WordPress. Es gibt einige Erweiterungen, die laufen auch auf den neuen Systemen, auch wenn angegeben wird, das nur bis zur WordPress-Version 2.3 ein reibungsloses Funktion garantiert wird.
Was ich sagen möchte, ist, das Code-Snippets und Plug-Ins auch gepflegt werden sollten und das man keine Scheu davor haben sollte, auch andere Blogger / Programmierer zu fragen.

Zum Abschluss möchte ich nur noch sagen, dass die Arbeit der Menschen, die Code-Snippets selbst erstellen und anderen Usern zur Verfügung stellen nicht hoch genug honoriert werden kann. Über ein Dankeschön, ob finanziell oder anhand eines Kommentares wird sich keiner beklagen.

In diesem Sinne: Danke Frank. :)