highlight_string

Function • Return type changed in PHP 8.4

Syntax highlighting of a string.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
Improved
PHP 8.5
PHP 8.6

highlight_string Function synopsis

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

Parameters

$string

Typestring

The PHP code to be highlighted. This should include the opening tag.

$return

OptionalTypeboolDefault valuefalse

Set this parameter to true to make this function return the highlighted code.

Return value

Typestring|true

If $return is set to true, returns the highlighted code as a string instead of printing it out. Otherwise, it will return true.

Changes to the highlight_string Function

PHP 8.4

  • Return type changed: string|bool to string|true
- highlight_string(string $string, bool $return = false): string|bool
+ highlight_string(string $string, bool $return = false): string|true

PHP 8.0

  • Return type added: string|bool
  • Parameter type added for parameter #1 ($string): string
  • Parameter type added for parameter #2 ($return): bool
  • Parameter default value added for position #2 ($return): false
- highlight_string($string, $return)
+ highlight_string(string $string, bool $return = false): string|bool

highlight_string Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes