PHP-Handbuch: Wandelt alle geeigneten Zeichen in entsprechende HTML-Codes um

Beschreibung

string htmlentities ( string $string [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = ini_get("default_charset") [, bool $double_encode = true ]]] )

Die Funktion ist komplett identisch zu htmlspecialchars, allerdings wandelt htmlentities wirklich alle Zeichen, die eine HTML-Code-Entsprechung haben, in diese Entsprechung um.

Möchten Sie stattdessen die HTML Entities dekodieren, verwenden Sie bitte die Funktion html_entity_decode.

Parameter-Liste

string

Die Eingabezeichenkette.

flags

Eine Bitmaske von einem oder mehreren der folgenden Flags, die die Behandlung von Anführungszeichen, ungültigen Zeichenfolgen und den genutzten Dokumententyp festlegen. Der Standardwert ist ENT_COMPAT | ENT_HTML401.

**Verfügbare `flags` Konstanten**
Konstante	Beschreibung
`ENT_COMPAT`	Konvertiert nur doppelte Anführungszeichen und lässt einfache Anführungszeichen unverändert.
`ENT_QUOTES`	Konvertiert sowohl doppelte als auch einfache Anführungszeichen.
`ENT_NOQUOTES`	Lässt doppelte und einfache Anführungszeichen unverändert.
`ENT_IGNORE`	Verwirft ungültige Code Unit Sequenzen anstatt eine leere Zeichenkette zurückzugeben. Die Nutzung dieser Option ist nicht empfehlenswert, da sie » Auswirkungen auf die Sicherheit haben kann.
`ENT_SUBSTITUTE`	Ersetzt ungültige Codepoints mit einem Unicode Ersatz Zeichen U+FFFD (UTF-8) oder &#FFFD; (andernfalls) anstatt sie zu belassen wie sie sind. Dies kann zum Beispiel nützlich sein, um die Wohlgeformtheit von XML-Dokumenten mit eingebetteten externen Inhalten sicher zu stellen.
`ENT_DISALLOWED`	Ersetzt Code Unit Sequenzen, welche in dem angegebenen Dokumenttyp ungültig sind, mit einem Unicode Ersatz Zeichen U+FFFD (UTF-8) oder &#FFFD; (andernfalls).
`ENT_HTML401`	Behandle Code als HTML 4.01.
`ENT_XML1`	Behandle Code als XML 1.
`ENT_XHTML`	Behandle Code als XHTML.
`ENT_HTML5`	Behandle Code als HTML 5.

encoding

Ein optionaler Parameter, der die Zeichenkodierung für eine Konvertierung definiert.

Wird dieser Parameter ausgelassen, so wird der Standardwert für encoding verwendet, welcher von der verwendeten PHP-Version abhängig ist. In PHP 5.6 und neuer wird die Konfigurationseinstellung default_charset als Standardwert verwendet. PHP 5.4 und 5.5. verwenden UTF-8 als Standardwert. Frühere Versionen verwenden ISO-8859-1.

Obwohl dieser Parameter technisch optional ist wird es stark empfohlen den korrekten Wert für den jeweiligen Programmcode zu spezifizieren, falls sie PHP 5.5 oder früher verwenden, oder falls default_charset für die jeweilige Eingabe inkorrekt sein könnte.

Die folgenden Zeichensätze werden unterstützt:

**Unterstützte Zeichensätze**
Zeichensatz	Alias	Beschreibung
ISO-8859-1	ISO8859-1	Westeuropäisch, Latin-1.
ISO-8859-5	ISO8859-5	Wenig verwendeter kyrillischer Zeichensatz (Latin/Cyrillic).
ISO-8859-15	ISO8859-15	Westeuropäisch, Latin-9. Enthält das Euro-Zeichen sowie französische und finnische Buchstaben, die in Latin-1(ISO-8859-1) fehlen.
UTF-8		ASCII-kompatibles Multi-Byte 8-Bit Unicode.
cp866	ibm866, 866	DOS-spezifischer kyrillischer Zeichensatz.
cp1251	Windows-1251, win-1251, 1251	Windows-spezifischer kyrillischer Zeichensatz.
cp1252	Windows-1252, 1252	Windows spezifischer Zeichensatz für westeuropäische Sprachen.
KOI8-R	koi8-ru, koi8r	Russisch.
BIG5	950	Traditionelles Chinesisch, hauptsächlich in Taiwan verwendet.
GB2312	936	Vereinfachtes Chinesisch, nationaler Standard-Zeichensatz.
BIG5-HKSCS		Big5 mit Hongkong-spezifischen Erweiterungen; traditionelles Chinesisch.
Shift_JIS	SJIS, SJIS-win, cp932, 932	Japanisch
EUC-JP	EUCJP, eucJP-win	Japanisch
MacRoman		Zeichensatz, der von Mac OS verwendet wurde.
''		Eine leere Zeichenkette aktiviert die Erkennung durch die Kodierung des Skripts (Zend multibyte), default_charset und die aktuelle Sprachumgebung (siehe nl_langinfo und setlocale), in dieser Reihenfolge. Nicht empfehlenswert.

Hinweis: Weitere Zeichensätze sind nicht implementiert. Statt dessen wird die Standard-Kodierung verwendet und eine Warnung ausgegeben.

double_encode

Wenn double_encode ausgeschaltet ist, verändert PHP keine bereits vorhandenen HTML-Entities. Standardmäßig wird jedoch alles konvertiert.

Rückgabewerte

Gibt die kodierte Zeichenkette zurück.

Enthält der string eine in dem übergebenen encoding ungültige Code Unit Sequenz, wird eine leere Zeichenkette zurückgegeben, sofern weder das ENT_IGNORE noch das ENT_SUBSITUTE Flag gesetzt sind.

Changelog

Version	Beschreibung
5.6.0	Der Standardwert für den Parameter `encoding` wurde so angepasst, dass dieser Wert aus der Konfigurationseinstellung default_charset bezogen wird.
5.4.0	Der Standardwert für `encoding` wurde zu UTF-8 geändert.
5.4.0	Die Konstanten `ENT_SUBSTITUTE`, `ENT_DISALLOWED`, `ENT_HTML401`, `ENT_XML1`, `ENT_XHTML` und `ENT_HTML5` wurden hinzugefügt.
5.3.0	Die Konstante `ENT_IGNORE` wurde hinzugefügt.
5.2.3	Der Parameter `double_encode` wurde hinzugefügt.

Beispiele

Beispiel #1 Ein htmlentities-Beispiel


<?php
$str = "Ein 'Anführungszeichen' ist <b>fett</b>";

// Gibt aus: Ein 'Anf&uuml;hrungszeichen' ist &lt;b&gt;fett&lt;/b&gt;
echo htmlentities($str);

// Gibt aus: Ein &#039;Anf&uuml;hrungszeichen&#039; ist &lt;b&gt;fett&lt;/b&gt;
echo htmlentities($str, ENT_QUOTES);
?>

Beispiel #2 Nutzung von ENT_IGNORE


<?php
$str = "\x8F!!!";

// Gibt eine leere Zeichenkette aus
echo htmlentities($str, ENT_QUOTES, "UTF-8");

// Gibt "!!!" aus
echo htmlentities($str, ENT_QUOTES | ENT_IGNORE, "UTF-8");
?>

Siehe auch

html_entity_decode
get_html_translation_table
htmlspecialchars
nl2br
urlencode