15.2.2. JavaScripte registrieren

Wir benutzen die entsprechende Funktion aus der API um ein neues Script zu registrieren.

<?php
function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
	...
} 

Es gilt:

  • $handle (string)
  • $src (string)
  • $deps (array)
  • $ver (string|bool|null)
  • $in_footer (bool)

Zurückgegeben wird ein boolscher Wert, also entweder true oder false.

Beachten Sie, dass das JavaScript hier noch nicht eingebunden wird. Wir teilen WordPress lediglich mit, dass es ein neues Script gibt, wo dieses zu finden ist und welche Abhängigkeiten es hat.

Es empfiehlt sich, alle JavaScripte, die das Plugin nutzt, vorweg zu registrieren. So können andere Plugins wiederum ebenfalls einen Hook nutzen um sie zu modifizieren, zu entfernen oder ähnliches.

Hinweis

Sie Fragen sich sicherlich warum die Angabe einer Versionsnummer nötig ist. Der Grund ist, dass WordPress JavaScript- und CSS-Dateien intern (und im Backend) zu einer Datei zusammenfassen und in einen separaten Cache legen kann. Das soll die Ladezeit verringern. Der Cache wird immer dann neu aufgebaut, wenn sich bei einer registrierten Datei die Versionsnummer verändert.

Wenn Sie ein Plugin-Update vorbereiten und keine Versionsnummer angeben oder vergessen die Nummer zu verändern, kann es sein dass es bei manchen Benutzern zu Fehlern kommt da im Browser-Cache noch immer die alten Dateien liegen. Sie sollten daher regen Gebrauch von diesem Wert machen.

Beispiel:

You’re not allowed to see this content. Please log in first.