nl2br

(PHP 4, PHP 5)

nl2br改行文字の前に HTML の改行タグを挿入する

説明

string nl2br ( string $string [, bool $is_xhtml = true ] )

string に含まれるすべての改行文字 (\r\n\n\r\n および \r) の前に '<br />' あるいは '<br>' を挿入して返します。

パラメータ

string

入力文字列。

is_xhtml

XHTML 準拠の改行を使うか否か。

返り値

変更後の文字列を返します。

例1 nl2br() の使用法

<?php
echo nl2br("foo isn't\n bar");
?>

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

foo isn't<br />
 bar

例2 is_xhtml パラメータの使用による、妥当な HTML 形式のマークアップの生成

<?php
echo nl2br("Welcome\r\nThis is my HTML document"false);
?>

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

Welcome<br>
This is my HTML document

例3 さまざまな改行文字

<?php
$string 
"This\r\nis\n\ra\nstring\r";
echo 
nl2br($string);
?>

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

This<br />
is<br />
a<br />
string<br />

変更履歴

バージョン 説明
5.3.0 オプションの is_xhtml パラメータが追加されました。
4.0.5 nl2br() は XHTML 準拠となりました。 PHP 4.0.5 より前の全てのバージョンでは、 nl2br() は、string の全ての改行記号の前に '<br />' の代わりに '<br>' を挿入して返します。

参考

  • htmlspecialchars() - 特殊文字を HTML エンティティに変換する
  • htmlentities() - 適用可能な文字を全て HTML エンティティに変換する
  • wordwrap() - 指定した文字数で文字列を分割する
  • str_replace() - 検索文字列に一致したすべての文字列を置換する

add a note add a note

User Contributed Notes 9 notes

up
11
N/A
5 years ago
Here's a more simple one:

<?php
/**
 * Convert BR tags to nl
 *
 * @param string The string to convert
 * @return string The converted string
 */
function br2nl($string)
{
    return
preg_replace('/\<br(\s*)?\/?\>/i', "\n", $string);
}
?>

Enjoy
up
7
CGameProgrammer at gmail dot com
9 years ago
It's important to remember that this function does NOT replace newlines with <br> tags. Rather, it inserts a <br> tag before each newline, but it still preserves the newlines themselves! This caused problems for me regarding a function I was writing -- I forgot the newlines were still being preserved.

If you don't want newlines, do:

<?php
$Result
= str_replace( "\n", '<br />', $Text );
?>
up
4
Anders Norrbring
8 years ago
Seeing all these suggestions on a br2nl function, I can also see that neither would work with a sloppy written html line break.. Users can't be trusted to write good code, we know that, and mixing case isn't too uncommon.

I think this little snippet would do most tricks, both XHTML style and HTML, even mixed case like <Br> <bR /> and even <br            > or <br     />.

<?php
function br2nl($text)
{
    return 
preg_replace('/<br\\s*?\/??>/i', '', $text);
}
?>
up
2
j dot mons54 at gmail dot com
1 year ago
for bbcode :

<?php
$message
nl2br(preg_replace('#(\\]{1})(\\s?)\\n#Usi', ']', stripslashes($message)));
?>
up
4
blacknine313 at gmail dot com
6 years ago
After a recent post at the forums on Dev Shed, I noticed that it isn't mentioned, so I will mention it.

nl2br returns pure HTML, so it should be after PHP anti-HTML functions ( such as strip_tags and htmlspecialchars ).
up
3
ngkongs at gmail dot com
7 years ago
to replace all linebreaks to <br />
the best solution (IMO) is:

<?php
function nl2br2($string) {
$string = str_replace(array("\r\n", "\r", "\n"), "<br />", $string);
return
$string;
}
?>

because each OS have different ASCII chars for linebreak:
windows = \r\n
unix = \n
mac = \r

works perfect for me
up
1
darenschwenke at yahoo dot com
2 months ago
This one works with br tags having attributes, in any case,
closed or  not closed, and does not double linefeeds

<?php
 
/**
 * convert br tags to nl
 *
 * @param string The string to convert
 * @return string The converted string
 */

function br2nl($string)
{
    return
preg_replace("/<br[^>]*>\s*\r*\n*/is", "\n", $string);
}
?>

I combine this with strip_tags() for dead simple "contenteditable" fields allowing only text and linefeeds.
up
-1
hyponiq at gmail dot com
6 years ago
On the contrary, <b>mark at dreamjunky.comno-spam</b>, this function is rightfully named.  Allow me to explain.  Although it does re-add the line break, it does so in an attempt to stay standards-compliant with the W3C recommendations for code format.

According to said recommendations, a new line character must follow a line break tag.  In this situation, the new line is not removed, but a break tag is added for proper browser display where a paragraph isn't necessary or wanted.
up
-12
billhicks at yahoo dot com
30 days ago
Your new site does not work in ie.

But you already know this and I guess you don't really care.

its all about style now - funny because this is a php site not a css/java/ajax site.

piss off!!!!!!!!!!!!!!!
To Top