Run a Greasemonkey script only once per page load?

javascript greasemonkey tampermonkey
Joren picture Joren · Nov 16, 2010 · Viewed 12.1k times · Source

If you create a Greasemonkey script with @include * and go to a site like youtube, it runs the script 20+ times every time you refresh. This is on Firefox, not sure about Chrome.
Is there a way to prevent this?

Answer

Brock Adams picture Brock Adams · Nov 16, 2010

First, you probably don't want the script to run in iFrames.
You can block that using the @noframes directive which now works in both Greasemonkey and Tampermonkey as of October, 2014.

For older versions, or for script engines that don't support @noframes, you can use this code, just after the metadata block:

if (window.top != window.self)  //don't run on frames or iframes
{
    //Optional: GM_log ('In frame');
    return;
}


Second, you can wait and fire your GM code, once, on page load. Wrap everything in a main() and call it on the load event, like so:

window.addEventListener ("load", LocalMain, false);

function LocalMain () {
    // Your code goes here.
}


Third, you can exclude sites or pages by adding // @exclude directives to the metadata block.

Overall, it's best to avoid universally included GM scripts, if possible.

Other methods might set flags or reload the page with URL parameters. These get tricky so save them as a last resort.

Related questions

window.close and self.close do not close the window in Chrome

The issue is that when I invoke window.close() or self.close() it doesn't close the window. Now there seems to be a belief that in Chrome you can't close by script any window that is not script created. That …

Read More
Userscript to wait for page to load before executing code techniques?

I'm writing a Greasemonkey user script, and want the specific code to execute when the page completely finishes loading since it returns a div count that I want to be displayed. The problem is, that this particular page sometimes takes …

Read More
Simulating a mousedown, click, mouseup sequence in Tampermonkey?

I would like to simulate a whole click not just document.getElementsByClassName()[0].click(); How do I do that? Search results all seem to be about handling such events, not triggering them.

Read More