文字列の構文ハイライト表示

# highlight_string

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

highlight_string — 文字列の構文ハイライト表示

### 説明

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

PHP 組込みの 構文ハイライタで定義されたカラーを使用して `str` を構文ハイライト表示したものを、html マークアップで出力あるいは返します。

### パラメータ

`string`

  ハイライト表示する PHP コード。開始タグを含む必要があります。

`return`

  このパラメータを `true` にすると、この関数はハイライトされたコードを返します。

### 戻り値

`return` が `true` の場合は、 ハイライトされたコードを文字列として返し、表示しません。 それ以外の場合は、`true` を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.4.0 | 戻り値の型が、string|bool から string|true に変更されました。
8.3.0 | 結果のHTMLが変更されました。

### 例

例1 highlight_string() の例

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

上の例の出力は以下となります。

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

上の例の 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>

### 注意

> 注意: `return` パラメータを使う場合、この関数は内部的に出力バッファリングを使います。 そのため、ob_start() コールバック関数の中では使えません。

生成される HTML マークアップは、変わる可能性があります。

### 参考

- highlight_file() - ファイルの構文ハイライト表示
- ハイライトに関する INI 設定

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