userScripts (Legacy)

Warnung: Dies ist die Dokumentation für die veraltete userScripts API. Sie ist in Firefox für Manifest V2 verfügbar. Für Funktionalität mit User-Skripten in Manifest V3 siehe die neue userScripts API.

Verwenden Sie diese API, um Benutzer-Skripte zu registrieren. Dies sind Drittanbieter-Skripte, die dazu entwickelt wurden, Webseiten zu manipulieren oder neue Funktionen bereitzustellen. Durch die Registrierung eines Benutzer-Skripts wird der Browser angewiesen, das Skript auf Seiten anzuwenden, die den während der Registrierung angegebenen URL-Mustern entsprechen.

Diese API bietet ähnliche Funktionen wie contentScripts, jedoch mit Merkmalen, die für die Handhabung von Drittanbieter-Skripten geeignet sind:

  • Ausführung in einer isolierten Sandbox: Jedes Benutzer-Skript wird in einer isolierten Sandbox innerhalb der Webinhaltprozesse ausgeführt, um versehentliche oder absichtliche Beeinträchtigungen zwischen Skripten 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 gewährt wurden: Das API-Skript, das die Berechtigungen der Erweiterung erbt, kann registrierten Benutzer-Skripten verpackte WebExtension-APIs bereitstellen. Ein API-Skript wird mit dem Manifest-Schlüssel "user_scripts" in der Manifest-Datei der Erweiterung deklariert.

Warnung: Diese API erfordert das Vorhandensein des user_scripts Schlüssels in der manifest.json, auch wenn kein API-Skript angegeben ist. Beispiel: user_scripts: {}.

Um die API zu verwenden, rufen Sie register() auf und übergeben Sie 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 die Benutzer-Skripte registriert wurden) entladen wird. Sie sollten daher ein Benutzer-Skript von einer Erweiterungsseite registrieren, die mindestens so lange bestehen bleibt, wie die Benutzer-Skripte registriert bleiben sollen.

Typen

userScripts.RegisteredUserScript

Das object, das von der register() Methode 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 dem API-Skript zur Verfügung steht, registriert in "user_scripts", das vor der Ausführung eines Benutzer-Skripts ausgeführt wird. Verwenden Sie es, um den Export der zusätzlichen APIs auszulösen, die vom API-Skript bereitgestellt werden, sodass sie für das Benutzer-Skript verfügbar sind.

Browser-Kompatibilität

Siehe auch