【PHP8.x】rtrim関数の使い方
rtrim関数は、指定された文字列の右端(末尾)から、特定の文字または一連の空白文字を削除し、整形された新しい文字列を返す関数です。この関数は、文字列操作において、データのクリーンアップや整形を行う際に非常に有用です。例えば、ユーザーがWebフォームに入力したデータや、ファイルから読み込んだテキストデータなどに、意図せず含まれてしまう末尾のスペース、タブ、改行コードなどの不要な文字を効率的に除去することができます。これにより、データの表示や、その後の処理で発生する可能性のある問題を未然に防ぎ、データの整合性を高めることができます。
rtrim関数は、二つの引数を取ります。最初の引数には、操作対象となる元の文字列を指定します。この引数は必須であり、削除処理を行う対象となるデータです。二番目の引数(オプション)には、削除したい文字のリストを指定します。この引数を省略した場合、rtrim関数はデフォルトで、スペース(" ")、タブ("\t")、改行("\n")、キャリッジリターン("\r")、ヌルバイト("\0")、垂直タブ("\v")といった一般的な空白文字を削除の対象とします。
この関数は、指定された文字が文字列の右端から連続して現れる限り削除を続けます。たとえば、「 Hello World !!! 」という文字列に対して、空白を削除するようにrtrim関数を実行すると、「 Hello World」という結果が得られます。また、第二引数に「 /ABC」のように複数の文字を指定した場合、文字列の右端から「/」、「A」、「B」、「C」のいずれかの文字が連続して見つかる限り、それらがすべて削除されます。
rtrim関数は、元の文字列自体を変更するのではなく、加工された新しい文字列を戻り値として返します。このため、元のデータはそのままに保ちつつ、加工後の整形されたデータを利用したい場合に特に適しています。システム開発において、データの品質を維持し、表示や処理に適した形式に整えるために頻繁に利用される、基本的ながら非常に重要な文字列操作関数の一つです。
基本的な使い方
構文(syntax)
<?php
$string = " Hello PHP \n\t";
$charactersToStrip = " \n\t";
$result = rtrim($string, $charactersToStrip);
?>
引数(parameters)
string $string, string $characters = " \n\r\t\v\0"
- string $string: 末尾の空白文字を取り除く対象となる文字列
- string $characters = " \n\r\t\v\0": 末尾から削除する文字を指定する文字列。省略時は、スペース、タブ、改行、キャリッジリターン、垂直タブ、NULL文字が対象となります
戻り値(return)
string
文字列の末尾から指定された文字を除去した結果の文字列を返します。