関数・クラス解説

nl2br

version:PHP 4, PHP 5, PHP 7 (公式)

文字列中の改行文字の前に改行タグ(<br /> <br>)を挿入する

フォーマット

string : nl2br ( string $string [, bool $is_xhtml = TRUE ] )

パラメータ

string $string (必須)
入力文字列

bool $is_xhtml = TRUE
改行タグがXHTML 準拠か否か。デフォルトのTRUE指定時は<br />、FALSE指定時<br>となる

返値 string
処理実行後の文字列を返す

解説

入力文字列に含まれるすべての改行文字 (\r\n、 \n\r、\n および \r) の前に <br /> あるいは <br> を挿入する。
$is_xhtml がTRUEの場合、XHTML 準拠の改行となります。XHTML 準拠の改行とは<br /> で、非準拠の改行は<br/>となります。

記述サンプル

//PHP 7.4.6で実行

//文字列を指定
$string = "この文章はHTML形式の文章です\r\n改行コード部分に改行タグが挿入されるはずです";

//実行
echo nl2br($string);

//結果
この文章はHTML形式の文章です<br />
改行コード部分に改行タグが挿入されるはずです

//$is_xhtml を指定して実行
echo nl2br($string, false);

//結果 改行タグが違う
この文章はHTML形式の文章です<br>
改行コード部分に改行タグが挿入されるはずです


/* ----------------------------- */

//複数種類の改行文字を指定
$string = "HTMLの\r\n文章\n\rを\n書いています\r";

//実行
echo nl2br($string);

//結果表示
HTMLの<br />
文章<br />
を<br />
書いています<br />

参考リンク

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

タグ

改行 HTML タグ 挿入 String 文字列


公式リファレンス

書式

nl2br ( string $string [, bool $is_xhtml = TRUE ] ) : string

説明

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

パラメータ

string
入力文字列。
is_xhtml
XHTML 準拠の改行を使うか否か。

返値

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

サンプル

例1 nl2br() の使用法

echo nl2br("foo isn't\n bar");

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

foo isn't<br /> bar

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

echo nl2br("Welcome\r\nThis is my HTML document", false);

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

Welcome<br> This is my HTML document

例3 さまざまな改行文字

$string = "This\r\nis\n\ra\nstring\r"; echo nl2br($string);

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

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

参考

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


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール