Add function to escape discord markdown (#586)

* Add function to escape discord markdown Used this function in my bot, useful to escape markdown and formatting symbols with backslashes * Update src/Discord/functions.php added parameter type Co-authored-by: David <[email protected]> * Update functions.php escapeMarkdown Added explanation and also added # character to escape channel mentions Co-authored-by: David <[email protected]>
discord-php · Aug 24, 2021 · c74c3e3 · c74c3e3
1 parent 8e9cbf9
commit c74c3e3
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/Discord/functions.php b/src/Discord/functions.php
@@ -243,3 +243,17 @@ function normalizePartId($id_field = 'id')
         return $part;
     };
 }
+
+/**
+ * Escape various Discord formatting and markdown into a plain text:
+ * _Italics_, **Bold**, __Underline__, ~~Strikethrough~~, ||spoiler||
+ * `Code`, ```Code block```, > Quotes, >>> Block quotes
+ * #Channel @User
+ * A backslash will be added before the each formatting symbol
+ * 
+ * @return string the escaped string unformatted as plain text
+ */
+function escapeMarkdown(string $text): string
+{
+    return addcslashes($text, '#*:>@_`|~');
+}