wordwrap

関数の概要

PHPの wordwrap 関数は、指定した文字数ごとに文字列に自動的に改行コードを挿入するための関数です。長い文章や文字列を読みやすく整形したい場合に便利で、特に表示幅を制限したい場合に役立ちます。

パラメータの説明

  • string $string — 処理対象の文字列。
  • int $width = 75 — 改行を挿入する文字数(幅)。デフォルトは75文字。
  • string $break = "n" — 挿入する改行文字列。デフォルトは改行コードの n
  • bool $cut = false — trueの場合、$widthで区切られていない単語も強制的に切り取って改行する。falseの場合は単語の途中での改行を避ける。

戻り値

改行を挿入した新しい文字列を返します。元の文字列は変更されません。

使用例

基本的な使い方

<?php
$text = "これは非常に長い文章であり、適切に改行を入れて表示させたい場合に使います。";
echo wordwrap($text, 10);
?>

こちらの例では、10文字ごとに自動的に改行(デフォルトの”n”)が挿入されます。

改行コードを変更する

<?php
$text = "PHPで改行コードをカスタマイズすることも可能です。";
echo wordwrap($text, 8, "<br>");
?>

この例では、8文字ごとにHTMLの<br>タグを挿入し、ウェブページ上での改行を実現しています。

単語の途中で強制的に改行する場合

<?php
$text = "超長い単語eeeeeeeeeeeeeeeeeeeeeeeeeeeeeを強制改行します。";
echo wordwrap($text, 10, "n", true);
?>

単語が長すぎて幅を超える場合に、cutをtrueに設定すると単語の途中でも強制的に改行されます。

関連する関数

  • nl2br — 改行コードをHTMLの<br>タグに変換する
  • substr — 文字列の一部を切り出す
  • explode — 文字列を区切り文字で分割する

まとめ

PHPの wordwrap 関数は、長い文字列を指定した文字数ごとに自動で改行し、可読性を向上させる際に非常に便利な関数です。デフォルトでは単語の途中での改行を防ぎつつ改行を挿入しますが、必要に応じて強制的に単語の途中でも改行することができます。ウェブページ上で改行タグを使いたい場合や、文章の整形を行いたい場合にぜひ活用しましょう。