Skip to content
This repository was archived by the owner on Jan 31, 2020. It is now read-only.

Commit ab2408f

Browse files
committed
docs: Documents auto escape property with HeadMeta helper
Specifically, documents the one time you'd want to disable auto escaping for it.
1 parent cae8d8c commit ab2408f

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/book/helpers/head-meta.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ The following methods are also supported with `XHTML1_RDFA` doctype set with the
2626
- `prependProperty($property, $content, $modifiers)`
2727
- `setProperty($property, $content, $modifiers)`
2828

29+
Finally, starting in 2.11.2, you can call the following method to determine
30+
whether or not to autoescape values used in meta tags:
31+
32+
- `setAutoEscape(bool $autoEscape = true)` (enabled by default)
33+
34+
> ### AutoEscape
35+
>
36+
> **Disable this flag at your own risk.** The one documented case where it is
37+
> necessary to disable the flag is when setting the `X-UA-Compatible`
38+
> `http-equiv` value to switch behavior for Internet Explorer, as escaped values
39+
> will not trigger correct representation.
40+
2941
The `$keyValue` item is used to define a value for the `name` or `http-equiv`
3042
key; `$content` is the value for the 'content' key, and `$modifiers` is an
3143
optional associative array that can contain keys for `lang` and/or `scheme`.

0 commit comments

Comments
 (0)