Destaque de sintaxe de uma string

# highlight_string

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

highlight_string — Destaque de sintaxe de uma string

### Descrição

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

Mostra ou retorna uma marcação html para uma versão destacada do código PHP fornecido usando as cores definidas no marcador de sintaxe integrado do PHP.

### Parâmetros

`string`

  O código PHP a ser destacado. Isso deve incluir a etiqueta de abertura.

`return`

  Defina este parâmetro como `true` para fazer esta função retornar o código destacado.

### Valor Retornado

Se `return` estiver definido para `true`, retorna o código destacado como uma string ao invés de exibi-lo. Caso contrário, retorna `true`.

### Registro de Alterações

Versão | Descrição
--- | ---
8.4.0 | O tipo de retorno foi alterado de string|bool para string|true.
8.3.0 | O HTML resultante foi alterado.

### Exemplos

Exemplo #1 Exemplo de highlight_string()

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

O exemplo acima produzirá:

    <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>

Saída do exemplo acima no 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: Quando o parâmetro `return` é usado, esta função usa um buffer de saída interno, portanto não pode ser usada em uma função callback da função ob_start().

A marcação HTML gerada está sujeita a alterações.

### Veja Também

- highlight_file() - Destaca a sintaxe de um arquivo
- Diretivas INI para destaque

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open