Saltar al contenido

highlight_string()

En este artículo, nos centraremos en la función highlight_string() de PHP. Le proporcionaremos una visión general de la función, cómo funciona y ejemplos de su uso.

Introducción a la función highlight_string()

La función highlight_string() es una función integrada en PHP que se utiliza para resaltar la sintaxis de una cadena que contiene código PHP. Se puede usar para mostrar la sintaxis de una cadena PHP en una página web o para generar una cadena PHP formateada con fines de documentación.

La función highlight_string() toma una cadena PHP como argumento y genera una representación HTML de la cadena con resaltado de sintaxis. Admite un único parámetro booleano opcional para controlar si el HTML resaltado se imprime directamente o se devuelve como una cadena.

Cómo usar la función highlight_string()

Usar la función highlight_string() es muy sencillo. Solo necesita llamar a la función y pasar la cadena PHP que desea resaltar. A continuación, un ejemplo:

Cómo usar la función highlight_string()?

php
<?php
$string = '<‌?php echo "Hello, World!"; ?>';
highlight_string($string);
?>

En este ejemplo, tenemos una variable $string que contiene una cadena PHP que queremos resaltar. Luego, llamamos a la función highlight_string() y pasamos la cadena como argumento. La función genera una representación HTML de la cadena PHP con resaltado de sintaxis y la envía al navegador.

Personalización de la salida

La función highlight_string() tiene una firma simple: highlight_string(string $string, bool $return = false): string|void. Por defecto, envía el HTML resaltado directamente al navegador. Si establece el segundo parámetro en true, la función devuelve la cadena HTML en lugar de imprimirla, lo que le permite almacenarla o modificarla antes de la salida.

A continuación, un ejemplo de cómo usar el parámetro de retorno:

Ejemplo de highlight_string() en PHP

php
<?php
$string = '<‌?php echo "Hello, World!"; ?>';
$highlighted = highlight_string($string, true);
echo '<pre>' . $highlighted . '</pre>';
?>

Tenga en cuenta que highlight_string() no admite clases CSS personalizadas, números de línea ni alternancia de etiquetas cortas. Para un resaltado de sintaxis avanzado con estilos personalizados o números de línea, normalmente se usaría la función token_get_all() para analizar manualmente el código y aplicar su propio CSS, o bien utilizar una biblioteca de terceros.

Conclusión

En conclusión, la función highlight_string() es una herramienta integrada para generar cadenas PHP formateadas con resaltado de sintaxis. Al comprender cómo usar la función y su parámetro de retorno, puede aprovechar esta función para mostrar código legible y resaltado en sus aplicaciones web.

Práctica

¿Cuál es la función principal de la función highlight_string() en PHP?

¿Te resulta útil?

Vista previa dual-run — compárala con las rutas Symfony en producción.