<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.html-entity-decode" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>html_entity_decode</refname>

<refpurpose>Convierte las entidades HTML a sus caracteres correspondientes</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>string</type><methodname>html_entity_decode</methodname>

<methodparam><type>string</type><parameter>string</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

<function>html_entity_decode</function> es la función contraria de

<function>htmlentities</function>: convierte las entidades HTML de

la cadena <parameter>string</parameter> a sus caracteres correspondientes.

</para>

<para>

De manera más explícita, esta función decodifica todas las entidades (incluyendo

las entidades numéricas) que 1) son necesariamente válidas para el tipo

de documento seleccionado - es decir, para XML, esta función no decodifica las

entidades nombradas que pueden estar definidas en una DTD - y 2) cuyo carácter

o caracteres están en el juego de caracteres codificado con la codificación elegida y

están permitidos en el tipo de documento seleccionado. Todas las demás entidades

se dejan tal cual.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

La cadena de entrada.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>flags</parameter></term>

<listitem>

<para>

Una máscara de uno o varios flag siguientes, que especifican la forma

en que deben ser gestionadas las comillas y qué tipo de documento debe ser utilizado.

Por omisión, es <literal>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</literal>.

<table>

<title>Constantes disponibles para <parameter>flags</parameter></title>

<tgroup cols="2">

<thead>

<row>

<entry>Constante</entry>

<entry>Descripción</entry>

</row>

</thead>

<tbody>

<row>

<entry><constant>ENT_COMPAT</constant></entry>

<entry>Convierte las comillas dobles e ignora las comillas simples.</entry>

</row>

<row>

<entry><constant>ENT_QUOTES</constant></entry>

<entry>Convierte las comillas dobles y las comillas simples.</entry>

</row>

<row>

<entry><constant>ENT_NOQUOTES</constant></entry>

<entry>No convierte ninguna comilla.</entry>

</row>

<row>

<entry><constant>ENT_SUBSTITUTE</constant></entry>

<entry>

Reemplaza las secuencias de código no válidas con un carácter de reemplazo

Unicode U+FFFD (UTF-8) o &amp;#FFFD; (de lo contrario) en lugar de devolver una

cadena vacía.

</entry>

</row>

<row>

<entry><constant>ENT_HTML401</constant></entry>

<entry>

Gestiona el código como HTML 4.01.

</entry>

</row>

<row>

<entry><constant>ENT_XML1</constant></entry>

<entry>

Gestiona el código como XML 1.

</entry>

</row>

<row>

<entry><constant>ENT_XHTML</constant></entry>

<entry>

Gestiona el código como XHTML.

</entry>

</row>

<row>

<entry><constant>ENT_HTML5</constant></entry>

<entry>

Gestiona el código como HTML 5.

</entry>

</row>

</tbody>

</tgroup>

</table>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>encoding</parameter></term>

<listitem>

&strings.parameter.encoding;

&reference.strings.charsets;

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve la cadena decodificada.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.1.0</entry>

<entry>

<parameter>flags</parameter> cambió de <constant>ENT_COMPAT</constant> a

<constant>ENT_QUOTES</constant> | <constant>ENT_SUBSTITUTE</constant> | <constant>ENT_HTML401</constant>.

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

<parameter>encoding</parameter> ahora puede ser nullable.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Decodificar entidades HTML</title>

<programlisting role="php">

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

Podría preguntarse por qué

<literal>trim(html_entity_decode('&amp;nbsp;'));</literal>

no reduce la cadena a la cadena vacía. Esto se debe a que

la entidad <literal>&amp;nbsp;</literal>

no es un código ASCII 32 (que sería eliminado por

<function>trim</function>), sino un código ASCII 160 (<literal>0xa0</literal>)

en la codificación por omisión <literal>ISO 8859-1</literal>.

</para>

</note>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>htmlentities</function></member>

<member><function>htmlspecialchars</function></member>

<member><function>get_html_translation_table</function></member>

<member><function>urldecode</function></member>

</simplelist>

</para>

</refsect1>

</refentry>