【PHP8.x】wordwrap関数の使い方
作成日: 更新日:
『wordwrap関数は、指定した文字数で文字列を自動的に折り返して改行を挿入する処理を実行する関数です。』
この関数は、長い文章を読みやすく整形するために使用されます。第一引数に対象の文字列を、第二引数には一行あたりの最大文字数を指定します。デフォルトでは75文字で折り返されます。関数は単語の区切り(主にスペース)を認識し、指定された文字数を超えないように適切な場所で改行を挿入します。第三引数には、改行に使用する文字列を指定できます。デフォルトは改行文字 \n
ですが、例えばウェブページで表示するために "<br>"
のようにHTMLの改行タグを指定することも可能です。第四引数に true
を設定すると、指定した文字数よりも長い単語があった場合に、その単語の途中であっても強制的に分割して改行します。デフォルトの false
の場合は長い単語を分割しないため、行が指定した文字数を超えることがあります。この関数を利用することで、メール本文やログ出力など、様々な場面でテキストの可読性を向上させることができ、処理結果として改行が挿入された新しい文字列が返されます。
基本的な使い方
構文(syntax)
<?php
$text = "This is a long line of text that needs to be wrapped into smaller pieces.";
$wrapped_text = wordwrap($text, 20);
echo $wrapped_text;
?>
引数(parameters)
string $string, int $width = 75, string $break = "\n", bool $cut_long_words = false
- string $string: 折り返したい文字列
- int $width = 75: 1行あたりの最大文字数
- string $break = "\n": 改行文字として使用する文字列
- bool $cut_long_words = false: 長すぎる単語を強制的に折り返すかどうか
戻り値(return)
string
指定された文字列を、指定された幅で折り返した新しい文字列を返します。