此页面由社区从英文翻译而来。了解更多并加入 MDN Web Docs 社区。

Element:getHTML() 方法

基线 2024
最近可用

自 2024年9月 起,此特性已在最新浏览器中得到支持。但在较旧的设备或浏览器中可能无法运行。

Element 接口的 getHTML() 方法将元素的 DOM 序列化为 HTML 字符串。

该方法提供选项参数,可序列化作为影子根的子节点。选项可包含已设为 serializable 的嵌套影子根,和/或指定的 ShadowRoot 对象数组(可以是公开的或不公开的)。

不带参数时,不会序列化作为影子根的子节点,行为与读取 Element.innerHTML 的值相同。

请注意,某些浏览器会将属性值中的 <> 序列化为 &lt;&gt;(参见浏览器兼容性)。这用于防止潜在的安全漏洞(突变型 XSS):攻击者可能构造绕过净化函数的输入,从而实施跨站脚本(XSS)攻击。

语法

js
getHTML(options)

参数

options 可选

含以下可选参数的选项对象:

serializableShadowRoots

指定是否包含 serializable影子根的布尔值,默认值为 false

shadowRoots

要序列化的 ShadowRoot 对象数组。无论是否标记为 serializable,以及是公开还是不公开,都会包含它们。默认值为空数组。

返回值

表示元素 HTML 序列化结果的字符串。

异常

无。

规范

规范
HTML
# dom-element-gethtml

浏览器兼容性

参见