nl2br

Function • Params and return types changed in PHP 8.0

Inserts HTML line breaks before all newlines in a string.

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

nl2br Function synopsis

nl2br(string $string, bool $use_xhtml = true): string

Parameters

$string

Typestring

The input string.

$use_xhtml

OptionalTypeboolDefault valuetrue

Whether to use XHTML compatible line breaks or not.

Return value

Typestring

Returns the altered string.

Changes to the nl2br Function

PHP 8.0

  • Return type added: string
  • Parameter name of parameter #1 changed: $str to $string
  • Parameter type added for parameter #1 ($string): string
  • Parameter name of parameter #2 changed: $is_xhtml to $use_xhtml
  • Parameter type added for parameter #2 ($use_xhtml): bool
  • Parameter default value added for position #2 ($use_xhtml): true
- nl2br($str, $is_xhtml)
+ nl2br(string $string, bool $use_xhtml = true): string

nl2br 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