PHP | highlight_string()函数

简介

highlight_string()函数是一个PHP内置函数，用于将字符串中的PHP代码语法高亮显示。这个函数在调试和查看源码时非常有用。

该函数的语法如下：

string highlight_string(string $str, bool $return = false)

其中，$str参数是需要高亮显示的字符串，$return参数默认为false，表示在输出高亮显示的同时不返回字符串，如果将其设置为true，则返回高亮显示的字符串。

用法示例

基本用法

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

该代码会将$code变量中的PHP代码语法高亮输出。

输出结果如下：

<code><span style="color: #0000BB">&lt;?php<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #007700">echo</span><span style="color: #000000">&nbsp;</span><span style="color: #DD0000">&quot;Hello, World!&quot;</span><span style="color: #000000">;</span><br><span style="color: #0000BB">?&gt;</span></code>

返回高亮显示的字符串

<?php
$code = 'echo "Hello, World!";';
$highlighted_code = highlight_string($code, true);
echo $highlighted_code;
?>

该代码将$code变量中的PHP代码语法高亮显示并返回高亮显示的字符串。

输出结果如下：

<code><span style="color: #0000BB">&lt;?php<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #007700">echo</span><span style="color: #000000">&nbsp;</span><span style="color: #DD0000">&quot;Hello, World!&quot;</span><span style="color: #000000">;</span><br><span style="color: #0000BB">?&gt;</span></code>

添加样式

我们可以通过在生成的HTML代码中添加样式来改变代码的外观。

<?php
$code = 'echo "Hello, World!";';
echo '<style type="text/css">
    code {
        font-family: Consolas, Monaco, Courier New, Courier, monospace;
        font-size: 12px;
        color: #333;
        background-color: #f8f8f8;
        border: 1px solid #ccc;
        display: block;
        padding: 10px;
        margin: 10px 0;
    }
    span.comment {
        color: #999;
        font-style: italic;
    }
    span.keyword {
        color: #007700;
    }
    span.string {
        color: #DD0000;
    }
    span.number {
        color: #DD00DD;
    }
</style>';

highlight_string($code);
?>

该代码将在生成的HTML代码中添加样式，改变代码的外观。

输出结果如下：

<style type="text/css">
    code {
        font-family: Consolas, Monaco, Courier New, Courier, monospace;
        font-size: 12px;
        color: #333;
        background-color: #f8f8f8;
        border: 1px solid #ccc;
        display: block;
        padding: 10px;
        margin: 10px 0;
    }
    span.comment {
        color: #999;
        font-style: italic;
    }
    span.keyword {
        color: #007700;
    }
    span.string {
        color: #DD0000;
    }
    span.number {
        color: #DD00DD;
    }
</style>
<code><span style="color: #0000BB">&lt;?php<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="keyword" style="color: #007700">echo</span><span style="color: #000000">&nbsp;</span><span class="string" style="color: #DD0000">&quot;Hello, World!&quot;</span><span style="color: #000000">;</span><br><span style="color: #0000BB">?&gt;</span></code>

注意事项

1. highlight_string()函数默认不会输出HTML标记（即不会将输出嵌入到<pre>和</pre>标记中），如果需要输出HTML标记，可以使用highlight_string()的第二个参数，如下：

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

2. highlight_string()函数在Windows平台上默认使用ANSI字符集，而在Linux和Unix平台上默认使用UTF-8字符集。如果在Windows平台上需要使用UTF-8字符集，可以通过在php.ini文件中设置default_charset = "utf-8"来实现。

参考资料

• PHP官方文档