【PHP8.x】chunk_split関数の使い方
作成日: 更新日:
chunk_split関数は、文字列を指定した長さに分割し、指定した文字列を挿入する関数です。具体的には、入力された文字列を、指定されたlength
の長さごとに分割し、分割された各文字列の末尾にseparator
を挿入します。この関数は、長い文字列を読みやすくしたり、特定のフォーマットに合わせる必要がある場合に役立ちます。
length
パラメータは、分割する文字列の長さを指定します。デフォルト値は76です。separator
パラメータは、分割された文字列の間に挿入する文字列を指定します。デフォルト値は"\r\n"(キャリッジリターンと改行)です。
例えば、長い文字列をメールのヘッダに含める場合、RFC 2822の仕様に従って、78文字以下に分割し、改行コードを挿入する必要があります。chunk_split関数を使うことで、このような処理を簡単に行うことができます。
引数には、分割したい文字列、分割する長さ(オプション)、区切り文字(オプション)を指定します。戻り値は、分割され、指定された区切り文字が挿入された文字列です。元の文字列が変更されることはありません。もしlength
に不正な値(例えば負の数)が与えられた場合、関数の動作は未定義となります。通常はエラーが発生するか、予期しない結果になる可能性があります。
基本的な使い方
構文(syntax)
chunk_split(string $string, int $length = 76, string $separator = "\r\n"): string
引数(parameters)
string $string, int $length = 76, string $separator = "\r\n"
- string $string: 分割したい元の文字列
- int $length = 76: 文字列を分割する際の1つのチャンク(塊)あたりの最大文字数。デフォルトは76文字です。
- string $separator = "\r\n": 各チャンクの末尾に追加される区切り文字。デフォルトは改行コード(CRLF)です。
戻り値(return)
string
指定された文字列を指定された長さで分割し、各チャンクの末尾に指定された文字列を追加した新しい文字列を返します。