contentScripts.RegisteredContentScript

RegisteredContentScript is returned by a call to contentScripts.register() and represents the content scripts registered in that call.

It defines a single function unregister(), which can be used to unregister the content scripts.

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

Methods

contentScripts.RegisteredContentScript.unregister()
Unregisters the content scripts represented by this object.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome No support NoEdge No support NoFirefox Full support 59Opera No support NoFirefox Android Full support 59
unregisterChrome No support NoEdge No support NoFirefox Full support 59Opera No support NoFirefox Android Full support 59

Legend

Full support  
Full support
No support  
No support

Examples

This code toggles a registered content script on a browser action click:

var registered = null;

async function register() {

  registered = await browser.contentScripts.register({
    matches: ["*://*.org/*"],
    js: [{
      code: "document.body.innerHTML = '<h1>This page has been eaten<h1>'"
    }],
    runAt: "document_idle"
  });

}

function toggle() {
  if (registered) {
    registered.unregister();
    registered = null;
  } else {
    register();
  }
}

browser.browserAction.onClicked.addListener(toggle);

 

Document Tags and Contributors

Contributors to this page: wbamberg
Last updated by: wbamberg,