userScripts (Legacy)

Warnung: Dies ist die Dokumentation für die Legacy-API userScripts. Sie ist in Firefox für Manifest V2 verfügbar. Für die Nutzung von Benutzer-Skripten mit Manifest V3 siehe die neue userScripts API.

Verwenden Sie diese API, um Benutzer-Skripte zu registrieren, also Drittanbieter-Skripte, die Webseiten manipulieren oder neue Funktionen bereitstellen. Das Registrieren eines Benutzer-Skripts weist den Browser an, das Skript an Seiten anzuhängen, die den während der Registrierung angegebenen URL-Mustern entsprechen.

Diese API bietet ähnliche Möglichkeiten wie contentScripts, umfasst jedoch Funktionen, die speziell für den Umgang mit Drittanbieter-Skripten geeignet sind:

  • Die Ausführung erfolgt in einer isolierten Sandbox: Jedes Benutzer-Skript wird in einer isolierten Sandbox innerhalb der Web-Content-Prozesse ausgeführt, um eine unbeabsichtigte oder absichtliche Beeinflussung anderer Skripte zu verhindern.
  • Zugriff auf die globalen Werte window und document, die sich auf die Webseite beziehen, an die das Benutzer-Skript angehängt ist.
  • Kein Zugriff auf WebExtension-APIs oder zugehörige Berechtigungen, die der Erweiterung erteilt wurden: Das API-Skript, das die Berechtigungen der Erweiterung erbt, kann gepackte WebExtension-APIs für registrierte Benutzer-Skripte bereitstellen. Ein API-Skript wird im Manifest der Erweiterung mithilfe des Schlüssels "user_scripts" deklariert.

Warnung: Diese API erfordert die Präsenz des Schlüssels user_scripts in der manifest.json, selbst wenn kein API-Skript angegeben ist. Beispiel: user_scripts: {}.

Um die API zu verwenden, rufen Sie register() auf und übergeben ein Objekt, das die zu registrierenden Skripte definiert. Die Methode gibt ein Promise zurück, das mit einem RegisteredUserScript-Objekt aufgelöst wird.

Hinweis: Benutzer-Skripte werden abgemeldet, wenn die zugehörige Erweiterungsseite (von der aus die Benutzer-Skripte registriert wurden) entladen wird. Daher sollten Sie ein Benutzer-Skript von einer Erweiterungsseite aus registrieren, die mindestens so lange bestehen bleibt, wie Sie möchten, dass das Benutzer-Skript registriert bleibt.

Typen

userScripts.RegisteredUserScript

Das object, das von der Methode register() zurückgegeben wird. Es repräsentiert die registrierten Benutzer-Skripte und wird verwendet, um die Benutzer-Skripte abzumelden.

Methoden

userScripts.register()

Registriert Benutzer-Skripte.

Ereignisse

userScripts.onBeforeScript

Ein Ereignis, das für das API-Skript verfügbar ist, registriert in "user_scripts", das ausgeführt wird, bevor ein Benutzer-Skript ausgeführt wird. Verwenden Sie es, um den Export zusätzlicher APIs des API-Skripts zu initiieren, sodass diese dem Benutzer-Skript zur Verfügung stehen.

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch