Blog-Modifikationen

Modifikationen im Blog

Es gibt zahlreiche Einstellungen in den einzelnen Themes der WordPress Software. Für manche Dinge einzustellen, kommen Sie aber oft nicht daran vorbei, in den php-Dateien des WordPress oder der Themes etwas zu ändern.

Was müssen Sie hierbei beachten, und wie geht man da am geschicktesten vor?

Jede Modifikation an einer Software ist eigentlich schlecht und sollte vermieden werden. Denn Sie können sich enorm viel Arbeit aufhalsen.

Unter einer Modifikation an einer Software versteht man gemeinhin, die Änderung an dem Quellcode der Software. Durch eine derartige Änderung verändern Sie den Quellcode des ursprünglich ausgelieferten Paketes. Das geht so lange gut, bis Sie eine neue Version der Software erhalten. Beachten Sie jetzt nicht, dass Sie an den Quelldateien was geändert haben, dann ist alles überschrieben und Sie fangen von vorne an.

Anders sollte es aussehen, wenn Sie bei Fehlern benachrichtigt werden, dass der Fehler bei der Version durch Änderung des Codes an der oder der Stelle behoben wird. Hier sollte auf der Seite des Herstellers die Änderung am Quellcode in seine Version eingebaut werden, und die gleiche oder ähnliche Änderung ausgeliefert werden. Derartiges nennt man nun nicht Modifikation sondern Korrektur.

Eine Korrektur sollte unkritisch sein und durch Auslieferung einer neuen Version sich selbst beheben. Die Korrektur obliegt dem Hersteller der Software, nicht Ihnen als Benutzer der Software. Sie ändern zwar die Software, doch der Hersteller auch. Bei der Modifikation ändern Sie etwas, ohne dass das der Hersteller weiß.

Wie gehe ich aber bei Modifikationen vor, ohne meinen Gehirnschmalz bei jeder neuen Auslieferung neu anstrengen zu müssen?
Hier eine Vorgehensweise, die Ihnen helfen kann.

 

Kennzeichnung im Quelltext

Wenn Sie irgendetwas im Coding ändern, sollten Sie das immer an 3 Stellen dokumentieren:

  1. Sie schreiben am Anfang der Datei, die Sie modifizieren, einen Kommentar, was und wann Sie was gemacht haben.
  2. Sie vergeben ein Kürzel, das sich auf die Modifikation bezieht, also z.B. HU20110102 ! (HU ist Ihre Namenskürzel und der Rest das Datum der Änderung!)
  3. Jede Zeile, die Sie in dem Quelltext ändern, markieren Sie mit diesem Kommentar, also „HU20110102“.
  4. Wenn Sie über mehrere Quelldateien für eine Modifikation etwas ändern, führen Sie obige Punkte entsprechend durch, aber mit der gleichen Korrekturnummer HU20110102
  5. Erstellen Sie eine Datei, in der Sie alle Modifikationen notieren, und speichern Sie diese Datei in das oberste Verzeichnis des Blogs als txt- oder doc-Datei, sowohl im Webspace als auch auf Ihrem PC.
  6. Diese Punkte führen Sie für alle Modifikationen diszipliniert durch.

Jetzt sind im Blog fast alle Dateien .php-Dateien, d.h. sie können php-Coding oder HTML-Coding enthalten, also müssen Sie die Dateien auch mit php-Kommentaren oder HTML-Kommentaren markieren.

Einen PHP-Kommentar schreiben Sie entweder mit

//Dies ist ein Kommentar

oder mit

/* Dies ist ein Kommentar */

Einen HTML-Kommentar schreiben Sie mit

<!– Dies ist ein Kommentar –>

Bitte hier beim HTML-Kommentar die Leerzeichen bei — nicht vergessen.

 

Beispiel einer Modifikation:
Nehmen wir folgendes sehr sinnbehaftete php-Programm:

<?php
// — Beispiel Programm
if($_GET(‚A‘) == ‚HUGO‘) {
print(„<br />“.“HUGO wurde übergeben“);
} else {
print(„<br >“. „Es wurden keine Parameter in ?a übergeben“);
}
?>

Sie sehen, das Programm wechselt mit <?php sofort in der 1. Zeile auf PHP! Also müssen Sie Ihren Kommentar in PHP-Syntax abgeben. Wir ändern jetzt HUGO in OTTO!
Also schreiben wir (Änderungen in rot):

<?php
// — Beispiel Programm
//—- Modi HU20110102 HUGO zu OTTO geändert
if($_GET(‚A‘) == ‚OTTO‘) { // HU20110102
print(„<br />“.“OTTO wurde übergeben“); //HU20110102
} else {
print(„<br >“. „Es wurden keine Parameter in ?a übergeben“);
}
?>

Sie müssen natürlich aufpassen, wo Sie welchen Kommentar abgeben: Falls die Datei nicht mit <?php beginnt, dann ist hier HTML Coding vorhanden. In HTML lauten die Kommentare
<!– Modi HU20110102 HUGO zu OTTO geändert –>
Sie können auch innerhalb des HTML-Codes auch mit
<?php //—— Modi HU20110102 HUGO zu OTTO geändert ?> einen PHP-Kommentar setzen, das steht Ihnen frei, hat allerdings den Vorteil, dass man im Quelltext diesen php-Kommentar im Gegensatz zu dem HTML-Kommentar nicht sieht.

Kennzeichnung der Dateien

Um immer wieder auf das Original schnell zurückkehren zu können, können Sie auch die Quelldatei vor der Änderung in einen anderen Namen also z.B. yxz.php in yxz_Orig.php ändern und auf Ihrem PC speichern. Die nächste Modifikation in dieser Datei würde dann yxz_HU20110102.php heißen.

So wissen Sie immer welche Modifikationen zu was gehören.
Sie wissen durch das Vorhandensein von yxz_Orig.php, dass Sie an der Datei eine Modifikation durchgeführt haben. Den Namen xyz.php müssen Sie ja beibehalten, da das Programm ja diese Datei aufruft 🙂

Wenn Sie jetzt noch eine Word- oder Text-Datei anlegen, wo Sie sich den Grund der Modifikation notieren, das Datum und Ihre Korrekturnummer festhalten, können Sie bei dem Einspielen einer neuen Version des Orginals alle *_ORI.php oder *_HUxxxx.php Dateien sichern und anschließend nachschauen, ob WordPress ähnliches geändert hat, oder ob Sie Ihre Modifikationen wieder anbringen können. (Modifikationsauflösung)

Vergleichen Sie mit einem geschickten Editor (siehe Beitrag über Editoren) zunächst die neu ausgelieferte Datei mit Ihrem *_ORI.php. Finden Sie keine Änderung (derartige Vergleiche können die Editoren), wissen Sie sofort, dass Sie Ihre Modifikation unverändert beibehalten können, denn in der Auslieferung wurde die Datei nicht verändert!

Andernfalls müssen Sie ein sog. Abmischen des Quelltextes durchführen. D.h. Sie müssen nachschauen, ob Ihre Modifikation noch passt!

Voraussetzung für das Ganze ist natürlich, dass Sie die WP-Software, die Themes und Plugins alle auch auf Ihrem PC gespeichert haben.

Ich persönlich mache derartige Kommentierungen wie oben immer doppelt, und erspare mir somit das Nachschauen im Original, was ich denn geändert habe:
Ich arbeite mit Kommentaren wie

  • //*del: Ich kopiere die Orginalzeile(n) und setze eine //*del davor, somit sind diese Zeilen weg.
  • //ins: Wenn ich Zeilen in das Coding einfüge, dann steht als Kommentar hinter der Zeile //ins HU20110102
  • //repl: Wenn ich in den Zeilen des Codings ändere, dann steht als Kommentar hinter der Zeile //repl HU20110102 (repl für replace)

Das obige Beispiel würde bei mir wie folgt aussehen.

<?php
// — Beispiel Programm
//—- Modi HU20110102 HUGO zu OTTO geändert
//*del if($_GET(‚A‘) == ‚HUGO‘) { //HU20110102
if($_GET(‚A‘) == ‚OTTO‘) { // repl HU20110102
//*DEL print(„<br />“.“HUGO wurde übergeben“); //HU20110102
print(„<br />“.“OTTO wurde übergeben“); // repl HU20110102
} else {
print(„<br >“. „Es wurden keine Parameter in ?a übergeben“);
}
?>

Aber das ist Geschmackssache! Machen Sie es so, dass Sie genau wissen, was Sie geändert haben, und es jederzeit nachvollziehen können.
[Natürlich schreibe ich bei PHP-Programmen mit Einrückungen, doch die hätten hier im Blog alles verschoben.]

Falls Sie eine andere Vorgehensweise bei Modifikationen haben, dann wäre ich sehr daran interessiert, wenn Sie mir diese als Kommentar hinterließen. Denn man lernt nie aus 🙂

Gruß
Bernd Klüppelberg

Bisher gibt es keinen Kommentar. Schreiben Sie einen Kommentar!

Schreibe einen Kommentar