userScripts.RegisteredUserScript (Legacy)

Warning: This is documentation for the legacy userScripts API. It's available in Firefox for Manifest V2. For functionality to work with user scripts in Manifest V3 see the new userScripts API.

A RegisteredUserScript object is returned by a call to userScripts.register() and represents the user scripts registered in that call.

The object defines a single method, unregister(), which is used to unregister the user scripts.

Note: If this object is destroyed (for example because it goes out of scope) then the associated scripts will be unregistered automatically, so you should keep a reference to this object for as long as you want the user scripts to stay registered.

Methods

unregister()

Unregisters the user scripts represented by this object.

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
RegisteredUserScript (Legacy)
Chrome – No support
Chrome
footnote No support
Edge – No support
Edge
footnote No support
Firefox – Full support
Firefox 68 (Release date: 2019-07-09)
footnote
footnote Only available for use in extensions using Manifest V2. For extension using Manifest V3, see userScripts.RegisteredUserScript.
Opera – No support
Opera
footnote No support
Safari – No support
Safari
footnote No support
Firefox for Android – Full support
Firefox for Android 68 (Release date: 2019-07-09)
footnote
footnote Only available for use in extensions using Manifest V2. For extension using Manifest V3, see userScripts.RegisteredUserScript.
Safari on iOS – No support
Safari on iOS
footnote No support
unregister (Legacy)
Chrome – No support
Chrome
footnote No support
Edge – No support
Edge
footnote No support
Firefox – Full support
Firefox 68 (Release date: 2019-07-09)
footnote
footnote Only available for use in extensions using Manifest V2. For extension using Manifest V3, see userScripts.unregister.
Opera – No support
Opera
footnote No support
Safari – No support
Safari
footnote No support
Firefox for Android – Full support
Firefox for Android 68 (Release date: 2019-07-09)
footnote
footnote Only available for use in extensions using Manifest V2. For extension using Manifest V3, see userScripts.unregister.
Safari on iOS – No support
Safari on iOS
footnote No support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.