highlight_file

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

highlight_fileColoración sintáctica de un fichero

Descripción

highlight_file(string $filename, bool $return = false): string|bool

Muestra la sintaxis colorizada del fichero filename, utilizando los colores definidos en el motor interno de PHP.

Muchos servidores están configurados para mostrar automáticamente el código fuente colorizado, con la extensión phps. Por ejemplo, example.phps muestra el código del script. Para activar esta funcionalidad, utilice esta línea en httpd.conf :

AddType application/x-httpd-php-source .phps

Parámetros

filename

La ruta hacia el fichero PHP a colorizar.

return

Al pasar este argumento a true, la función devuelve el código colorizado en lugar de mostrarlo.

Valores devueltos

Si el segundo parámetro opcional return vale true entonces highlight_file() devolverá el código generado, en lugar de mostrarlo. Si el segundo parámetro no vale true entonces highlight_file() devolverá true en caso de éxito, y false en caso contrario.

Historial de cambios

Versión Descripción
8.3.0 El HTML resultante ha cambiado.

Notas

Precaución

Se debe tener mucho cuidado al utilizar highlight_file() para asegurarse de que no se revelen información crítica como contraseñas u otra información que podría causar fugas de información.

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().

Ver también