aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md')
-rw-r--r--vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md52
1 files changed, 28 insertions, 24 deletions
diff --git a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md
index 58d0b3f75..8e8603053 100644
--- a/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md
+++ b/vendor/smarty/smarty/docs/designers/language-modifiers/language-modifier-unescape.md
@@ -1,39 +1,43 @@
-unescape {#language.modifier.unescape}
-========
+# unescape
`unescape` is used to decode `entity`, `html` and `htmlall`. It counters
-the effects of the [escape modifier](#language.modifier.escape) for the
+the effects of the [escape modifier](language-modifier-escape.md) for the
given types.
- Parameter Position Type Required Possible Values Default Description
- -------------------- -------- ---------- ------------------------------------------------------------------------------------------------------------ --------- ------------------------------------------------------------------------------------------------------------------------------
- 1 string No `html`, `htmlall`, `entity`, `html` This is the escape format to use.
- 2 string No `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](&url.php-manual;htmlentities) `UTF-8` The character set encoding passed to html\_entity\_decode() or htmlspecialchars\_decode() or mb\_convert\_encoding() et. al.
+## Basic usage
+```smarty
+{$myVar|unescape}
+```
+## Parameters
- <?php
+| Parameter Position | Type | Required | Possible Values | Default | Description |
+|--------------------|--------|----------|----------------------------------------------------------------------------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------|
+| 1 | string | No | `html`, `htmlall`, `entity`, | `html` | This is the escape format to use. |
+| 2 | string | No | `ISO-8859-1`, `UTF-8`, and any character set supported by [`htmlentities()`](https://www.php.net/htmlentities) | `UTF-8` | The character set encoding passed to html\_entity\_decode() or htmlspecialchars\_decode() or mb\_convert\_encoding() et. al. |
- $smarty->assign('articleTitle',
- "Germans use &quot;&Uuml;mlauts&quot; and pay in &euro;uro"
- );
+## Examples
- ?>
+```php
+<?php
-
+$smarty->assign('articleTitle',
+ "Germans use &quot;&Uuml;mlauts&quot; and pay in &euro;uro"
+ );
+```
These are example `unescape` template lines followed by the output
+```smarty
+{$articleTitle}
+Germans use &quot;&Uuml;mlauts&quot; and pay in &euro;uro
- {$articleTitle}
- Germans use &quot;&Uuml;mlauts&quot; and pay in &euro;uro
+{$articleTitle|unescape:"html"}
+Germans use "&Uuml;mlauts" and pay in &euro;uro
- {$articleTitle|unescape:"html"}
- Germans use "&Uuml;mlauts" and pay in &euro;uro
+{$articleTitle|unescape:"htmlall"}
+Germans use "Ümlauts" and pay in €uro
+```
- {$articleTitle|unescape:"htmlall"}
- Germans use "Ümlauts" and pay in €uro
-
-
-
-See also [escaping smarty parsing](#language.escaping), [escape
-modifier](#language.modifier.escape).
+See also [escaping smarty parsing](../language-basic-syntax/language-escaping.md), [escape
+modifier](language-modifier-escape.md).