Home / Lua Scripts Libraries API Manual / dtutils.string / escape_xml_characters
< details
is_not_sanitized >

# escape_xml_characters

## 🔗NAME

escape_xml_characters

## 🔗SYNOPSIS

escape characters for xml documents

## 🔗USAGE

    local ds = require "lib/dtutils.string"
    local result = ds.escape_xml_characters(str)

str - string - the string that needs escaped

## 🔗DESCRIPTION

escape_xml_characters provides the escape sequences for

    "&", '"', "'", "<", and ">"

with the corresponding

    "&amp;","&quot;", "&apos;", "&lt;", and "&gt;"

.

## 🔗RETURN VALUE

result - string - the string containing escapes for the xml characters

## 🔗REFERENCE

https://stackoverflow.com/questions/1091945/what-characters-do-i-need-to-escape-in-xml-documents

< details
is_not_sanitized >