【PHP8.x】mb_ltrim関数の使い方
作成日: 更新日:
mb_ltrim関数は、指定された文字列の先頭から、空白文字やその他の指定された文字を削除する関数です。この関数は、主に文字列の左端にある不要な文字を取り除くために使用されます。名前にある「mb_」は「マルチバイト」を意味しており、日本語や中国語などのように複数のバイトで一文字を表現するマルチバイト文字セットを扱う際に非常に重要です。PHPの標準的なltrim
関数では、マルチバイト文字を正確に処理できない場合がありますが、mb_ltrim
関数はマルチバイト文字を考慮して正しく動作するため、文字化けや意図しない結果を防ぐことができます。
この関数は、第一引数に処理したい文字列を受け取ります。オプションである第二引数には、削除したい文字のリストを文字列で指定することができます。この第二引数を省略した場合、デフォルトで半角スペース、タブ、改行などの一般的な空白文字が削除されます。処理の結果として、先頭の指定された文字が削除された新しい文字列を返します。元の文字列自体は変更されません。例えば、Webフォームから送信されたユーザー入力の先頭に誤って入力された空白を取り除いたり、データベースから取得したデータの前処理など、文字列を整形して利用する場面で大変役立ちます。これにより、データの整合性を保ち、期待通りの動作を実現することができます。
基本的な使い方
構文(syntax)
<?php
$text = " 日本語の文字列";
$result = mb_ltrim($text, " ");
?>
引数(parameters)
string $string, ?string $characters = null, ?string $encoding = null
- string $string: 先頭からトリムする対象の文字列
- ?string $characters = null: トリミングする文字を指定する文字列。指定しない場合は、空白文字 (スペース、タブ、改行など) がトリミングされます。
- ?string $encoding = null: 文字エンコーディングを指定する文字列。指定しない場合は、内部エンコーディングが使用されます。
戻り値(return)
string
指定された文字列の先頭から、指定された文字リストに含まれる文字をすべて削除した新しい文字列を返します。