highlight_string

(PHP 4, PHP 5, PHP 7, PHP 8)

highlight_stringAplica la sintaxis colorizada a código PHP

Descripción

highlight_string(string $string, bool $return = false): string|true

Muestra o devuelve el código HTML de la versión colorizada del código PHP contenido en el argumento str, utilizando los colores del sistema interno de coloración de PHP.

Parámetros

string

El código PHP a colorizar. Debe incluir también las etiquetas de apertura.

return

Definir este argumento a true para que esta función devuelva el código colorizado.

Valores devueltos

Si el segundo argumento opcional return es proporcionado, y vale true entonces highlight_string() devolverá la cadena colorizada en lugar de mostrarla inmediatamente. Si el segundo argumento no vale true entonces highlight_string() devolverá true.

Historial de cambios

Versión Descripción
8.4.0 El tipo de retorno ha pasado de string|bool a string|true.
8.3.0 El HTML resultante ha cambiado.

Ejemplos

Ejemplo #1 Ejemplo con highlight_string()

<?php
highlight_string
('<?php phpinfo(); ?>');
?>

El resultado del ejemplo sería:

<code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php phpinfo</span><span style="color: #007700">(); </span><span style="color: #0000BB">?&gt;</span>
</span>
</code>

Salida del ejemplo anterior en PHP 8.3:

<pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php phpinfo</span><span style="color: #007700">(); </span><span style="color: #0000BB">?&gt;</span></code></pre>

Notas

Nota:

Cuando el parámetro return se usa, esta función utiliza el almacenamiento en búfer de salida interno, por lo que no puede usarse dentro de una función de llamada de retorno ob_start().

El código HTML generado está sujeto a cambios.

Ver también