highlight_file

(PHP 4, PHP 5, PHP 7)

highlight_fileDestaca a sintaxe de um arquivo

Descrição

highlight_file ( string $filename [, bool $return = false ] ) : mixed

Imprime ou retorna a versão com destaque de sintaxe do código contigo no arquivo filename utilizando as cores definidas no destacador de sintaxe nativo do PHP.

Muitos servidores são configurados para destacar automaticamente os arquivos com extensão phps. Por exemplo, o arquivo example.phps quando acessado irá mostrar o código fonte com destaque de cores do arquivos. Para ativar isso, acrescente a seguinte linha no httpd.conf:

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

Parâmetros

filename

Caminho do arquivo PHP a ser destacado.

return

Informe esse parâmetro como true para fazer essa função retornar o código destacado (ao invés de imprimir).

Valor Retornado

Se return for true, retorna o código destacado como uma string ao invés de imprimir. Se não, irá retornar true no sucesso e false no caso de falhas.

Notas

Cuidado

Cuidados devem ser toamdos quando utilizando a função highlight_file() para prevenir que você não revele informações sensíveis inadivertidamente, como senhas e outros tipos de informações que possam criar risco de seguranaça.

Nota:

Esta função usa o interno buffer de saída com este parâmetro, então assim não pode ser usado dentro de uma função de callback para ob_start().

Veja Também