関数の概要
PHPの ltrim 関数は、文字列の左側(先頭)にある不要な空白や特定の文字を取り除くために使われます。特にユーザー入力の整形やファイルパスのクリーニング時など、文字列の先頭から余分な文字を削除したいケースで便利です。
パラメータの説明
string $str: 処理対象の文字列です。string $character_mask (省略可): 削除したい文字の集合を指定します。この引数を省略した場合は、空白文字(スペース、タブ、改行など)が対象になります。
戻り値
入力文字列から左側の指定された文字が削除された新しい文字列を返します。元の文字列は変更されません。
使用例
基本的な使い方(左の空白を削除)
<?php
$text = " Hello World! ";
$result = ltrim($text);
echo $result; // 出力: "Hello World! "
?>
この例では、文字列の先頭にある空白が削除され、後ろの空白はそのまま残ります。
特定の文字を指定して削除する
<?php
$text = "///example/path";
$result = ltrim($text, "/");
echo $result; // 出力: "example/path"
?>
先頭のスラッシュ(/)を指定して削除しています。これにより、ファイルパスの整形に便利です。
複数の文字を同時に削除する
<?php
$text = "abcHello World!";
$result = ltrim($text, "abc");
echo $result; // 出力: "Hello World!"
?>
先頭の ‘a’, ‘b’, ‘c’ のいずれかの文字を削除できます。複数指定した文字が混在していても、先頭から該当文字がある限り繰り返し削除されます。
関連する関数
rtrim: 文字列の右側(末尾)の空白や特定の文字を削除します。trim: 文字列の両端の空白や特定の文字を削除します。str_replace: 文字列内の特定の文字や文字列を置換します。
まとめ
ltrim はPHPで文字列の先頭から不要な空白や特定の文字を効率的に削除できる便利な関数です。ユーザー入力の整形やファイルパスの加工など、実務でもよく使われます。
また、削除対象の文字を細かく指定できるため、用途に応じて柔軟に使い分け可能です。文字列操作の基本としてぜひ覚えておきましょう。
