StripHyperlinks

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Game Types
mainline  mists  vanilla
Links
GitHub  Globe  Townlong Yak  Blizzard Docs  /api
Patch
Added in 10.1.0 / 3.4.2 / 1.14.4

Strips text of UI escape sequence markup.

stripped = StripHyperlinks(text [, maintainColor [, maintainBrackets [, stripNewlines [, maintainAtlases]]]])

Arguments

text

string - The text to be stripped of markup.

maintainColor

boolean? - If true, preserve color escape sequences.

maintainBrackets

boolean?

stripNewlines

boolean? - If true, strip all line break sequences.

maintainAtlases

boolean? - If true, preserve atlas texture escape sequences.

Returns

stripped

string - The stripped text.

Details

• If the supplied string contains a protected string sequence (|K) then this function will return an empty string.
• This function is used by the Addon compartment to strip markup from addon titles prior to sorting.

Patch changes

• Patch 10.1.0 (2023-05-02): Added.