Code Styling Project

Wenn man als Entwickler eines Plugins mal den Wunsch hat, mit Effekten rum zuspielen, dann stößt man schnell auf das Problem, das eine Unmenge von Javascripts geladen und ausgeführt werden.
Dabei war ich mir ziemlich sicher, das ich nur einen Teil der Scripte aktiv angefordert habe. Doch WordPress hat entschieden, wesentlich mehr laden zu wollen, als ich angefordert hab. Also bin ich diesem Phänomen auf den Grund gegangen und hab wieder mal einen kleinen Lapsus im WordPress Code gefunden.

Eigentlich wollte ich nur mit der Effekt Bibliothek etwas ausprobieren und war mir im Klaren darüber, dass ich das Laden der Komponente durch folgende Anweisung erreichen kann:

wp_enqueue_script('scriptaculous-effects');

Diese Anweisung im Plugin oder Theme führt dazu, das WordPress die Abhängigkeiten auflöst und evtl. als Basis benötigte Scripte mit ausliefert in der richtigen Reihenfolge. Die Beschreibung im Codex besagt das ja auch. Also erwartete ich beim Laden der Seite folgende Scripte in dieser Reihenfolge:

1. /wp-includes/js/prototype.js?ver=1.6
2. /wp-includes/js/scriptaculous/scriptaculous.js?ver=1.8.0
3. /wp-includes/js/scriptaculous/effects.js

Soviel zur Theorie, die Praxis sieht wieder mal anders aus. Das Ergebnis hat mich gleichermaßen überrascht wie erschreckt:

1. /wp-includes/js/prototype.js?ver=1.6
2. /wp-includes/js/scriptaculous/scriptaculous.js?ver=1.8.0
3. /wp-includes/js/scriptaculous/builder.js
4. /wp-includes/js/scriptaculous/effects.js
5. /wp-includes/js/scriptaculous/dragdrop.js
6. /wp-includes/js/scriptaculous/controls.js
7. /wp-includes/js/scriptaculous/slider.js
8. /wp-includes/js/scriptaculous/sound.js
9. /wp-includes/js/scriptaculous/effects.js?ver=1.8.0

Richtig beobachtet, effects.js wurde 2x geladen und 5 Scripte gleich mit, die ich nicht wollte und die man bei der Benutzung der Effekte auch nicht braucht. Also was ist hier los ?

Auf der Suche nach dem “Ort des Grauens” im WordPress Core Code bin ich schließlich auf die Datei script-loader.php gestoßen, in der die ganzen Abhängigkeiten definiert werden. Hier findet man auszugsweise das hier:

	$scripts->add( 'scriptaculous-root', '/wp-includes/js/scriptaculous/scriptaculous.js', array('prototype'), '1.8.0');
	$scripts->add( 'scriptaculous-builder', '/wp-includes/js/scriptaculous/builder.js', array('scriptaculous-root'), '1.8.0');
	$scripts->add( 'scriptaculous-dragdrop', '/wp-includes/js/scriptaculous/dragdrop.js', array('scriptaculous-builder', 'scriptaculous-effects'), '1.8.0');
	$scripts->add( 'scriptaculous-effects', '/wp-includes/js/scriptaculous/effects.js', array('scriptaculous-root'), '1.8.0');
	$scripts->add( 'scriptaculous-slider', '/wp-includes/js/scriptaculous/slider.js', array('scriptaculous-effects'), '1.8.0');
	$scripts->add( 'scriptaculous-sound', '/wp-includes/js/scriptaculous/sound.js', array( 'scriptaculous-root' ), '1.8.0' );
	$scripts->add( 'scriptaculous-controls', '/wp-includes/js/scriptaculous/controls.js', array('scriptaculous-root'), '1.8.0');
	$scripts->add( 'scriptaculous', '', array('scriptaculous-dragdrop', 'scriptaculous-slider', 'scriptaculous-controls'), '1.8.0');

Soweit sieht das alles korrekt aus, auch die Abhängigkeiten stimmen. Das falsche Ladeverhalten kann eigentlich nicht hier begründet sein. Also mal die Basisdatei scriptaculous.js selbst mal anschauen…

Und jetzt kommt Licht in die Sache, denn es gibt in dem Ordner 2 solche Dateien:

• scriptaculous.js
• wp-scriptaculous.js

Beide Dateien unterscheiden sich nur an einer Stelle, die aber essentiell ist: dem automatischen Nachladen von Komponenten! Während die Originaldatei scriptaculous.js ohne Angabe eines weiteren Parameters immer alle Komponenten lädt, macht die Datei wp-scriptaculous.js das nicht sondern lädt nur dann Komponenten aktiv selbst, wenn sie explizit angegeben wurden. Nun hab ich mich also auf die Suche durch mehrere WordPress Versionen gemacht, ob das schon mal mit der modifizierten Datei gemacht wurde und hab es in WP2.1 gefunden und auch Einträge dazu im WP Bug Trac.

Es ist tatsächlich so geplant, dass für WordPress die modifizierte Datei genommen werden soll, damit das mit der Auflösung der Anhängigkeiten von WP erledigt werden kann und nie zuviel Dateien geladen werden müssen. Das haben die Programmierer aber wieder mal irgendwann ignoriert oder versehentlich ausgebaut.

Abhilfe schafft die Modifikation (rotes hinzufügen) in folgender WP 2.6.1 Datei: /wp-includes/script-loader.php

$scripts->add( 'scriptaculous-root', '/wp-includes/js/scriptaculous/wp-scriptaculous.js', array('prototype'), '1.8.0');

Nach dieser Änderung funktioniert immer noch alles wie es soll, es werden aber jetzt nur noch die Komponenten geladen, die man wirklich angefordert hat oder die, von denen es tatsächlich auch abhängt.

Diese Änderung wirkt sich natürlich erheblich und positiv auf die Geschwindigkeit aus, mit der die Seiten nun ausgeliefert werden. Deshalb habe ich diesen Bug auch wieder für die Version WP 2.6.2 gemeldet und hoffe, das Core Team kümmert sich schleunigst darum: Ticket #7642 (new defect)