highlight_string
(PHP 4, PHP 5, PHP 7)
highlight_string — Syntax highlighting of a string
Description
Outputs or returns html markup for a syntax highlighted version of the given PHP code using the colors defined in the built-in syntax highlighter for PHP.
Parameters
-
str
-
The PHP code to be highlighted. This should include the opening tag.
-
return
-
Set this parameter to
TRUE
to make this function return the highlighted code.
Return Values
If return
is set to TRUE
, returns the highlighted
code as a string instead of printing it out. Otherwise, it will return
TRUE
on success, FALSE
on failure.
Examples
Example #1 highlight_string() example
<?php
highlight_string('<?php phpinfo(); ?>');
?>
The above example will output:
<code><span style="color: #000000"> <span style="color: #0000BB"><?php phpinfo</span><span style="color: #007700">(); </span><span style="color: #0000BB">?></span> </span> </code>
Notes
Note:
When the
return
parameter is used, this function uses internal output buffering so it cannot be used inside an ob_start() callback function.
The HTML markup generated is subject to change.
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.highlight-string.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.