Understanding PHP's html_entity_decode() Function

In PHP development, handling special characters and HTML entities is common. The function html_entity_decode() converts HTML entities back to their corresponding characters, enabling proper processing and display.

Syntax of html_entity_decode()

<code>string html_entity_decode ( string $string , int $flags = ENT_COMPAT | ENT_HTML401 , string|null $encoding = ini_get("default_charset") )</code>

Parameters

$string : The string to be decoded.

$flags : Optional flags specifying decoding rules; default ENT_COMPAT | ENT_HTML401.

$encoding : Optional encoding; default is ini_get("default_charset").

Return value

Returns the decoded string.

Usage examples

1. Decode HTML entities

<code>$str = "&lt;h1&gt;Hello, World!&lt;/h1&gt;";
$result = html_entity_decode($str);
echo $result; // outputs: <h1>Hello, World!</h1>
</code>

This example shows decoding a string containing HTML entities into the original markup.

2. Specify decoding flags and encoding

<code>$str = "&lt;h1&gt;Hello, World!&lt;/h1&gt;";
$result = html_entity_decode($str, ENT_QUOTES, "UTF-8");
echo $result; // outputs: <h1>Hello, World!</h1>
</code>

Here $flags is set to ENT_QUOTES to decode both double and single quotes, and $encoding is set to UTF-8.

3. Decode numeric character references

<code>$str = "&#60;&#104;&#49;&#62;Hello, World!&#60;&#47;&#104;&#49;&#62;";
$result = html_entity_decode($str, ENT_QUOTES, "UTF-8");
echo $result; // outputs: <h1>Hello, World!</h1>
</code>

This demonstrates decoding numeric HTML entities to their character equivalents.

Important notes

The function only decodes HTML entities, not HTML tags. Use strip_tags() if you need to remove tags.

When $flags is provided, the function follows the specified rule (e.g., ENT_COMPAT, ENT_QUOTES, ENT_HTML5).

The $encoding parameter determines the character set used for decoding (e.g., UTF-8, ISO-8859-1).

The function returns a new string; the original variable is unchanged.

Conclusion

The html_entity_decode() function is essential for converting HTML entities back to characters, improving readability and user experience in PHP applications. Understanding its syntax, parameters, examples, and caveats enables effective string handling.