関数の概要
PHPの rtrim 関数は、文字列の右端(末尾)から指定した文字を取り除くための関数です。特に、文字列の右側に余分な空白や特定の文字がある場合に、それらを削除して整形したいときに便利です。デフォルトでは、空白文字(スペース、タブ、改行など)が削除されます。
パラメータの説明
string $str— 右端の不要な文字を削除したい元の文字列。string $character_mask = " tnrx0B"— 削除したい文字をセットで指定します。指定しなければ空白類が対象となります。
戻り値
元の文字列から、右端にある指定した文字をすべて取り除いた新しい文字列を返します。元の文字列は変更されません。
使用例
基本的な使い方
<?php
$str = "Hello World! ";
echo "[" . rtrim($str) . "]";
?>
この例では、末尾のスペースが削除され、[Hello World!] と出力されます。
特定の文字を指定して削除する
<?php
$str = "Hello World!!!";
echo rtrim($str, "!"); // 出力: Hello World
?>
文字列の末尾にある感嘆符「!」をすべて削除しています。
複数文字をまとめて削除する
<?php
$str = "Example.php nr";
echo "[" . rtrim($str, " nr") . "]";
?>
末尾の空白や改行文字(n, r)をまとめて削除しています。
関連する関数
ltrim— 文字列の左端から指定文字を削除します。trim— 文字列の両端から指定文字を削除します。str_replace— 文字列中の特定の文字や文字列を置換します。
まとめ
rtrim はPHPで文字列の右側にある不要な空白や特定の文字を簡単に取り除ける便利な関数です。パラメータで削除したい文字を柔軟に指定でき、ファイル名の拡張子処理やログ出力の整形など実務でもよく使われます。文字列操作の基本として押さえておくと効率的にコードが書けます。
