Funktion html_entity_decode() - Entities umwandeln
Für viele Zeichen gibt es in HTML sogenannte Entities, z.B. & für das Und-Zeichen &, < für < und noch viele andere mehr. Bei der Verarbeitung von Zeichenketten kann es notwendig sein, die HTML-Entities wieder in ihre Ursprungszeichen umzuwandeln, z.B. wenn man Sonderzeichen und Umlaute zuvor für eine bestimmte Funktion mit htmlentities() in HTML-Entities umwandelte und diese wieder in ihrer ursprünglichen Form benötigt werden. Hierfür kann man die Funktion html_entity_decode() verwenden. Innerhalb der runden Klammern werden die Parameter wie folgt angegeben.
- Die Zeichenkette mit den umzuwandelnden Entities (string).
- flag-Konstanten, mit denen z.B. das Verhalten bei Anführungszeichen beeinflusst wird (int, optional).
- Zeichenkodierung (encoding, optional).
Angenommen, man hat eine Zeichenkette mit den HTML-Entities für die folgenden Zeichen.
- Ä ä Ö ö Ü ü ß " '
Die dazugehörigen HTML-Entitäten in der Zeichenkette wären wie folgt.
- Ä ä Ö ö Ü ü ß " '
Wendet man die Funktion auf die Zeichenkette an, erhält man den folgenden Rückgabewert.
- Ä ä Ö ö Ü ü ß " '
<?php
$str = 'Ä ä Ö ö Ü ü ß " '';
$str = html_entity_decode($str);
// Ausgabe Ä ä Ö ö Ü ü ß " '
echo $str;
?>flag-Konstanten
Alle HTML-Entities wurden bis auf ' in ihre ursprünglichen Zeichen umgewandelt. Der Zeichencode ' ist eine Entität für ein einfaches Anführungszeichen. Da einfache Anführungszeichen in PHP den Beginn und das Ende einer Zeichenkette markieren und somit eine besondere Bedeutung haben, werden diese in der Standardeinstellung nicht umgewandelt. Mit den folgenden flag-Konstanten, die man als zweiten Parameter angeben kann, hat man einige Möglichkeiten, um das Verhalten zu steuern. Bei der Angabe mehrerer flag-Konstanten werden diese mit einem | (Pipe) voneinander getrennt.
- ENT_COMPAT: Doppelte Anführungszeichen werden umgewandelt, einfache dagegen nicht (Standard).
- ENT_QUOTES: Einfache und doppelte Anführungszeichen werden umgewandelt.
- ENT_NOQUOTES: Einfache und doppelte Anführungszeichen werden nicht umgewandelt.
- ENT_HTML401: Behandelt den Code als HTML 4.01.
- ENT_XML1: Behandelt den Code als XML 1.
- ENT_XHTML: Behandelt den Code als XHTML.
- ENT_HTML5: Behandelt den Code als HTML5.
Beim folgenden Beispiel wurde die flag-Konstante ENT_QUOTES gesetzt, sodass auch ' umgewandelt wird.
<?php
$str = 'Ä ä Ö ö Ü ü ß " '';
$str = html_entity_decode($str, ENT_QUOTES);
// Ausgabe Ä ä Ö ö Ü ü ß " '
echo $str;
?>Einige Entities wie z.B. ' sind in HTML 4.01 noch nicht gültig gewesen. Setzt man die flag-Konstante ENT_HTML401, werden die in der Version 4.01 ungültigen Entities nicht umgewandelt.
<?php
$str = 'ä ö ü ß " ' '';
$str = html_entity_decode($str, ENT_QUOTES | ENT_HTML401);
// Ausgabe ä ö ü ß " ' '
echo $str;
?>In XML 1 werden dagegen die Umlaute nicht umgewandelt.
<?php
$str = 'ä ö ü ß " ' '';
$str = html_entity_decode($str, ENT_QUOTES | ENT_XML1);
// Ausgabe ä ö ü ß " ' '
echo $str;
?>In XHTML und HTML5 werden die Umlaute und Anführungszeichen umgewandelt.
<?php
$str = 'ä ö ü ß " ' '';
$str = html_entity_decode($str, ENT_QUOTES | ENT_XHTML);
// Ausgabe ä ö ü ß " ' '
echo $str;
?><?php
$str = 'ä ö ü ß " ' '';
$str = html_entity_decode($str, ENT_QUOTES | ENT_HTML5);
// Ausgabe ä ö ü ß " ' '
echo $str;
?>Zeichenkodierung
Als dritter Parameter wird die Zeichenkodierung angegeben. Falls man den Parameter auslässt, wird der Standardwert herangezogen und der ist abhängig von der PHP-Version. Ab PHP 5.6 gilt der Wert, den man in der Konfigurationsdatei php.ini unter default_charset angegeben hat. Für die Versionen davor gilt UTF-8 und vor PHP 5.4 gilt ISO-8859-1. Damit man die PHP-Anwendung auf einen anderen Server umziehen kann, sollte man auf die Angabe der Zeichenkodierung nicht verzichten. Der PHP-Interpreter erwartet als zweiten Parameter die flag-Konstanten. Falls man diese eigentlich nicht angeben möchte, kann man beim 2. Parameter ENT_COMPAT angeben und so auf die Standardeinstellung setzen.
<?php
$str = 'ä ö ü ß " ' '';
$str = html_entity_decode($str, ENT_COMPAT, 'UTF-8');
// Ausgabe ä ö ü ß " ' '
echo $str;
?>Mit htmlentities() und html_entity_decode() stehen dem Programmierer zwei hilfreiche Funktionen mit einigen Optionen zur Verfügung, um Zeichen in HTML-Entities und zurück umzuwandeln.