【PHP8.x】ltrim関数の使い方
ltrim関数は、指定された文字列の先頭（左側）から特定の文字を取り除いた新しい文字列を生成して返す関数です。主に、文字列の先頭にある不要な空白文字や記号などをクリーンアップする目的で使用されます。
この関数は、最初の引数として加工したい文字列を受け取ります。例えば、ユーザーがフォームに入力したデータや、ファイルから読み込んだテキストの先頭に、意図しないスペースや改行文字が含まれている場合に、それらを簡単かつ確実に取り除くことができます。
2番目の引数はオプションで、取り除きたい文字の集合を指定します。この引数を省略した場合、ltrim関数はデフォルトで、半角スペース、タブ（\t）、改行（\n）、キャリッジリターン（\r）、ヌルバイト（\0）、垂直タブ（\v）を文字列の先頭から取り除きます。もし、これらのデフォルト文字以外に、例えばスラッシュ（/）やハイフン（-）といった特定の記号を取り除きたい場合は、2番目の引数としてそれらの文字を指定します。指定された文字が文字列の先頭に連続して存在する場合、それらすべてが除去されます。
ltrim関数は、元の文字列そのものを変更するのではなく、加工済みの新しい文字列を戻り値として返します。このため、元の文字列はそのまま保持され、必要に応じて加工後の文字列を利用できます。例えば、「 Hello PHP」という文字列にltrim関数を適用すると、「Hello PHP」という新しい文字列が返されます。
基本的な使い方
構文(syntax)
<?php
$trimmed_string = ltrim($string, $characters);
引数(parameters)
string $string, string $characters = " \n\r\t\v\0"
- string $string: 文字列の先頭から指定された文字を削除した結果を返します。
- string $characters = " \n\r\t\v\0": $string の先頭から削除する対象となる文字を指定します。省略された場合は、空白文字、改行、キャリッジリターン、タブ、垂直タブ、NULL文字が対象となります。
戻り値(return)
string
文字列の先頭から指定された文字が削除された新しい文字列を返します。指定された文字が文字列の先頭にない場合、または指定文字が空の場合は、元の文字列がそのまま返されます。