Injects JavaScript code into a page.
You can inject code into pages whose URL can be expressed using a
match pattern
. To do so, its scheme must be one of:
http
,
https
，或
file
.
You must have the permission for the page's URL—either explicitly, as a host permission —or, via the activeTab permission .
You can also inject code into pages packaged with your own extension:
browser.tabs.create({url: "/my-page.html"}).then(() => {
browser.tabs.executeScript({
code: `console.log('location:', window.location.href);`
});
});
You don't need any special permissions to do this.
您
cannot
inject code into any of the browser's built-in pages, such as:
about:debugging
,
about:addons
, or the page that opens when you open a new empty tab.
The scripts you inject are called content scripts .
This is an asynchronous function that returns a
Promise
.
let executing = browser.tabs.executeScript(
tabId
,
// optional integer
details
// object
)
tabId
可选
integer
. The ID of the tab in which to run the script.
Defaults to the active tab of the current window.
details
An object describing the script to run.
It contains the following properties:
allFrames
可选
boolean
。若
true
, the code will be injected into all frames of the current page.
若
true
and
frameId
is set, then it will raise an error. (
frameId
and
allFrames
are mutually exclusive.)
若它是
false
, code is only injected into the top frame.
默认为
false
.
code
可选
string
. Code to inject, as a text string.
警告： Don’t use this property to interpolate untrusted data into JavaScript, as this could lead to a security issue.
file
可选
string
. Path to a file containing the code to inject.
To work cross-browser, you can specify the path as a relative URL, starting at the extension's root, like this:
"/path/to/script.js"
.
frameId
可选
integer
. The frame where the code should be injected.
默认为
0
(the top-level frame).
matchAboutBlank
可选
boolean
。若
true
, the code will be injected into embedded
about:blank
and
about:srcdoc
frames if your extension has access to their parent document. The code cannot be inserted in top-level
about:
帧。
默认为
false
.
runAt
可选
extensionTypes.RunAt
. The soonest that the code will be injected into the tab.
默认为
"document_idle"
.
A
Promise
that will resolve to an array of objects. The array's values represent the result of the script in every injected frame.
The result of the script is the last evaluated statement, which is similar to what would be output (the results, not any
console.log()
output) if you executed the script in the
Web 控制台
. For example, consider a script like this:
let foo='my result'; foo;
Here the results array will contain the string "
my result
" as an element.
The result values must be structured clonable (见 Data cloning algorithm ).
注意：
The last statement may be also a
Promise
, but this feature is unsupported by
webextension-polyfill
库。
If any error occurs, the promise will be rejected with an error message.
This example executes a one-line code snippet in the currently active tab:
function onExecuted(result) {
console.log(`We made it green`);
}
function onError(error) {
console.log(`Error: ${error}`);
}
const makeItGreen = 'document.body.style.border = "5px solid green"';
const executing = browser.tabs.executeScript({
code: makeItGreen
});
executing.then(onExecuted, onError);
This example executes a script from a file (packaged with the extension) called
"content-script.js"
. The script is executed in the currently active tab. The script is executed in subframes as well as the main document:
function onExecuted(result) {
console.log(`We executed in all subframes`);
}
function onError(error) {
console.log(`Error: ${error}`);
}
const executing = browser.tabs.executeScript({
file: "/content-script.js",
allFrames: true
});
executing.then(onExecuted, onError);
This example executes a script from a file (packaged with the extension) called
"content-script.js"
. The script is executed in the tab with an ID of
2
:
function onExecuted(result) {
console.log(`We executed in tab 2`);
}
function onError(error) {
console.log(`Error: ${error}`);
}
const executing = browser.tabs.executeScript(
2, {
file: "/content-script.js"
});
executing.then(onExecuted, onError);
BCD tables only load in the browser
注意：
This API is based on Chromium's
chrome.tabs
API. This documentation is derived from
tabs.json
in the Chromium code.
最后修改： , 由 MDN 贡献者