(PHP 4, PHP 5)
htmlentities — Преобразует все возможные символы в соответствующие HTML-сущности
$string
[, int $flags = ENT_COMPAT | ENT_HTML401
[, string $encoding = 'UTF-8'
[, bool $double_encode = true
]]] )Эта функция идентична htmlspecialchars() за исключением того, что htmlentities() преобразует все символы в соответствющие HTML-сущности (для тех символов, для которых HTML сущности существуют).
Если же вы хотите раскодировать строку (наоборот), используйте html_entity_decode().
stringВходная строка.
flagsБитовая маска из нижеуказанных флагов, определяющих режим обработки кавычек, некорректных кодовых последовательностей и используемый тип документа. По умолчанию используется ENT_COMPAT | ENT_HTML401.
| Название константы | Описание |
|---|---|
ENT_COMPAT |
Преобразует двойные кавычки, одинарные кавычки не изменяются. |
ENT_QUOTES |
Преобразует как двойные, так и одинарные кавычки. |
ENT_NOQUOTES |
Оставляет без изменения как двойные, так и одинарные кавычки. |
ENT_IGNORE |
Молча отбрасывает некорректные кодовые последовательности вместо возврата пустой строки. Использование этого флага не рекомендуется, так как это » может внести уязвимости в ваш код. |
ENT_SUBSTITUTE |
Заменяет некорреткные кодовые последовательности символом замены Юникода U+FFFD в случае использования UTF-8 и &#FFFD; при использовании другой кодировки, вместо возврата пустой строки. |
ENT_DISALLOWED |
Заменяет неверные коды символов для заданного типа документа символом замены юникода U+FFFD (UTF-8) или &#FFFD; (при использовании другой кодировки) вместо того, чтобы оставлять все как есть. Это может быть полезно, например, для того, чтобы убедиться в формальной правильности XML-документов со встроенным внешним контентом. |
ENT_HTML401 |
Обработка кода в соответствии с HTML 4.01. |
ENT_XML1 |
Обработка кода в соответствии с XML 1. |
ENT_XHTML |
Обработка кода в соответствии с XHTML. |
ENT_HTML5 |
Обработка кода в соответствии с HTML 5. |
encoding
Подобно htmlspecialchars(),
функция htmlentities() принимает необязательный третий
аргумент encoding, который задает кодировку,
используемую при преобразовании.
Если он не указан, то по умолчанию используется кодировка ISO-8859-1 в
версиях PHP до 5.4.0 и UTF-8 - начиная с 5.4.0 и далее.
Несмотря на то, что этот аргумент формально является необязательным, настоятельно
рекомендуется указать правильное значение в вашем коде.
Поддерживаются следующие кодировки:
| Кодировка | Псевдонимы | Описание |
|---|---|---|
| ISO-8859-1 | ISO8859-1 | Западно-европейская Latin-1. |
| ISO-8859-5 | ISO8859-5 | Редкоиспользуемая кириллическая кодировка (Latin/Cyrillic). |
| ISO-8859-15 | ISO8859-15 | Западно-европейская Latin-9. Добавляет знак евро, французские и финские буквы к кодировке Latin-1(ISO-8859-1). |
| UTF-8 | 8-битная Unicode, совместимая с ASCII. | |
| cp866 | ibm866, 866 | Кириллическая кодировка, применяемая в DOS. |
| cp1251 | Windows-1251, win-1251, 1251 | Кириллическая кодировка, применяемая в Windows. |
| cp1252 | Windows-1252, 1252 | Западно-европейская кодировка, применяемая в Windows. |
| KOI8-R | koi8-ru, koi8r | Русская кодировка. |
| BIG5 | 950 | Традиционный китайский, применяется в основном на Тайване. |
| GB2312 | 936 | Упрощенный китайский, стандартная национальная кодировка. |
| BIG5-HKSCS | Расширенная Big5, применяемая в Гонг-Конге. | |
| Shift_JIS | SJIS, SJIS-win, cp932, 932 | Японская кодировка. |
| EUC-JP | EUCJP, eucJP-win | Японская кодировка. |
| MacRoman | Кодировка, используемая в Mac OS. | |
| '' | Пустая строка активирует режим определения кодировки из файла скрипта (Zend multibyte), default_charset и текущей локали (см. nl_langinfo() и setlocale()), в указанном порядке. Не рекомендуется к использованию. |
Замечание: Остальные кодировки не поддерживаются, вместо них будет применена кодировка по умолчанию и сгенерировано предупреждение.
double_encode
При выключении параметра double_encode
PHP не будет преобразовывать существующие html-сущности. По умолчанию
преобразуется все без ограничений.
Возвращает преобразованную строку.
При наличии во входном параметре string недопустимой последовательности
символов в заданной кодировке encoding будет возвращена
пустая строка, если не установлены флаги ENT_IGNORE или
ENT_SUBSTITUTE.
| Версия | Описание |
|---|---|
| 5.4.0 |
Значение по умолчанию для параметра encoding было
изменено на UTF-8.
|
| 5.4.0 |
The constants ENT_SUBSTITUTE, ENT_DISALLOWED,
ENT_HTML401, ENT_XML1,
ENT_XHTML и ENT_HTML5.
|
| 5.3.0 |
Добавлена константа ENT_IGNORE.
|
| 5.2.3 |
Добавлен параметр double_encode.
|
| 4.1.0 |
Добавлен параметр encoding.
|
| 4.0.3 |
Добавлен параметр flags.
|
Пример #1 Пример использования htmlentities()
<?php
$str = "A 'quote' is <b>bold</b>";
// выводит: A 'quote' is <b>bold</b>
echo htmlentities($str);
// выводит: A 'quote' is <b>bold</b>
echo htmlentities($str, ENT_QUOTES);
?>
Пример #2 Использование ENT_IGNORE
<?php
$str = "\x8F!!!";
// Выводит пустую строку
echo htmlentities($str, ENT_QUOTES, "UTF-8");
// Выводит "!!!"
echo htmlentities($str, ENT_QUOTES | ENT_IGNORE, "UTF-8");
?>