【PHP8.x】mb_rtrim関数の使い方
mb_rtrim関数は、指定された文字列の末尾から、特定の文字(またはデフォルトの空白文字)を取り除く処理を実行する関数です。この関数の最大の特徴は、「mb_」というプレフィックスが示す通り、マルチバイト文字列(例えば日本語の全角文字など)を正確に処理できる点にあります。PHPの標準的なrtrim()
関数では、主に半角文字に特化しているため、全角スペースや特定のマルチバイト文字を文字列の末尾から正確に取り除くことが難しい場合がありますが、mb_rtrim()
関数は、こうしたマルチバイト文字の取り扱いにおいて非常に優れた機能を提供します。
この関数を使用する際は、第一引数に処理したい元の文字列を指定します。第二引数には、末尾から削除したい文字のリストを文字列として指定できます。この第二引数を省略した場合、半角スペース、タブ、改行などの一般的な空白文字が自動的に削除の対象となります。また、文字列のエンコーディングが明示的に異なる場合のために、第三引数としてエンコーディングを指定することも可能です。これにより、多様な文字コードを持つ文字列に対しても、一貫した正確な処理が保証されます。
mb_rtrim()
関数は、ウェブアプリケーションなどでユーザーが入力したデータの末尾に不要な空白文字が含まれている場合や、CSVファイルなどの外部データから読み込んだ文字列を整形する場合など、文字列のクリーンアップや正規化のシナリオで非常に役立ちます。この関数は、処理後の新しい文字列を返しますが、元の文字列自体は変更されないため、安心して利用できます。
基本的な使い方
構文(syntax)
function mb_rtrim(string $string, string $characters = " \n\r\t\v\0", ?string $encoding = null): string
引数(parameters)
string $string, string $characters = " \n\r\t\v\0", ?string $encoding = null
- string $string: 末尾の空白文字を削除したい文字列
- string $characters = " \n\r\t\v\0": $string の末尾から削除する文字を指定する文字列。指定しない場合は、一般的な空白文字(スペース、タブ、改行など)が削除されます。
- ?string $encoding = null: 文字エンコーディングを指定する文字列。指定しない場合は、内部エンコーディングが使用されます。
戻り値(return)
string
指定された文字列の末尾にある、指定された文字セットに一致する文字をすべて削除した新しい文字列を返します。