トップページ　→関数リファレンス　→テキスト処理　→文字列　→String 関数

関数・クラス解説

ltrim

version:PHP 4, PHP 5, PHP 7 (公式)

文字列の先頭にある空白（あるいは指定）文字を除去する

フォーマット

string : ltrim ( string $str [, string $character_mask ] )

パラメータ

string $str （必須）
処理対象の文字列

string $character_mask
除去する文字を指定。●..●で範囲を指定することも可能（例:A..Z と記述）。

返値
先頭から指定文字を取り除いた文字列を返します。

解説

文字列の先頭から、第二引数で指定された文字列を取り除きます。第二引数を指定しない場合はホワイトスペース（空白文字）を除去します。削除される文字については以下を参照してください。

" " (ASCII 32 (0x20)), 通常の空白
"\t" (ASCII 9 (0x09)), タブ
"\n" (ASCII 10 (0x0A)), 改行
"\r" (ASCII 13 (0x0D)), 復帰
"\0" (ASCII 0 (0x00)), NULL バイト
"\x0B" (ASCII 11 (0x0B)), 垂直タブ

記述サンプル

//PHP 7.4.6で実行
//文字列を指定(先頭にはスペースとタブがある)
$text = "   ABCDEFG" ;

//実行
echo ltrim($text);

//結果表示　スペースとタブが除去される
ABCDEFG

/* ----------------------------- */

//文字列を指定
$text = "ABCDEFG" ;

//除去する文字にABCの3文字を指定して実行
echo ltrim($text, "ABC") ;

//結果表示
DEFG

/* ----------------------------- */

//文字列を指定
$text = "ABCDEFGHIJKLMN" ;

//除去する文字にA～Mを範囲指定して実行
echo ltrim($text, "A..M") ;

//結果表示 A～Mが除去される
N

/* ----------------------------- */

//マルチバイト文字列には非対応
$text = "あいうえおかきくけこ" ;

//除去する文字にあ～うを範囲指定して実行
echo ltrim($text, "あ") ;

//結果表示 文字化けする
�うえおかきくけこ

参考リンク

・rtrim　文字列の最後から空白（あるいは指定の）文字を除去する
・trim　文字列の先頭および末尾にあるホワイトスペースを取り除く

公式リファレンス

書式

ltrim ( string $str [, string $character_mask ] ) : string

説明

文字列の最初から空白 (もしくはその他の文字) を取り除きます。

パラメータ

str: 入力文字列。
character_mask: character_maskパラメータにより、削除する文字を指定することも可能です。削除したい全ての文字をリストにしてください。..を文字の範囲を指定する際に使用可能です。

返値

この関数は文字列の最初から空白文字を取り除き、取り除かれた文字列を返します。2番目のパラメータを指定しない場合、 ltrim()は以下の文字を削除します。

" " (ASCII 32 (0x20)), 通常の空白。
"\t" (ASCII 9 (0x09)), タブ。
"\n" (ASCII 10 (0x0A)), 改行。
"\r" (ASCII 13 (0x0D)), 復帰。
"\0" (ASCII 0 (0x00)), NUL バイト。
"\x0B" (ASCII 11 (0x0B)), 垂直タブ。

サンプル

例1 ltrim() の使用例 


$text = "\t\tThese are a few words :) ...  ";
$binary = "\x09Example string\x0A";
$hello  = "Hello World";
var_dump($text, $binary, $hello);

print "\n";


$trimmed = ltrim($text);
var_dump($trimmed);

$trimmed = ltrim($text, " \t.");
var_dump($trimmed);

$trimmed = ltrim($hello, "Hdle");
var_dump($trimmed);

// ASCII 制御文字 (0 から 31 まで) を
// $binary の先頭から取り除きます
$clean = ltrim($binary, "\x00..\x1F");
var_dump($clean);


 上の例の出力は以下となります。 
string(32) "        These are a few words :) ...  "
string(16) "    Example string
"
string(11) "Hello World"

string(30) "These are a few words :) ...  "
string(30) "These are a few words :) ...  "
string(7) "o World"
string(15) "Example string
"