Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】mb_ltrim()関数の使い方

mb_ltrim関数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

mb_ltrim関数は、指定された文字列の先頭から、空白文字やその他の指定された文字を削除する関数です。この関数は、主に文字列の左端にある不要な文字を取り除くために使用されます。名前にある「mb_」は「マルチバイト」を意味しており、日本語や中国語などのように複数のバイトで一文字を表現するマルチバイト文字セットを扱う際に非常に重要です。PHPの標準的なltrim関数では、マルチバイト文字を正確に処理できない場合がありますが、mb_ltrim関数はマルチバイト文字を考慮して正しく動作するため、文字化けや意図しない結果を防ぐことができます。

この関数は、第一引数に処理したい文字列を受け取ります。オプションである第二引数には、削除したい文字のリストを文字列で指定することができます。この第二引数を省略した場合、デフォルトで半角スペース、タブ、改行などの一般的な空白文字が削除されます。処理の結果として、先頭の指定された文字が削除された新しい文字列を返します。元の文字列自体は変更されません。例えば、Webフォームから送信されたユーザー入力の先頭に誤って入力された空白を取り除いたり、データベースから取得したデータの前処理など、文字列を整形して利用する場面で大変役立ちます。これにより、データの整合性を保ち、期待通りの動作を実現することができます。

構文(syntax)

1<?php
2$text = "   日本語の文字列";
3$result = mb_ltrim($text, "  ");
4?>

引数(parameters)

string $string, ?string $characters = null, ?string $encoding = null

  • string $string: 先頭からトリムする対象の文字列
  • ?string $characters = null: トリミングする文字を指定する文字列。指定しない場合は、空白文字 (スペース、タブ、改行など) がトリミングされます。
  • ?string $encoding = null: 文字エンコーディングを指定する文字列。指定しない場合は、内部エンコーディングが使用されます。

戻り値(return)

string

指定された文字列の先頭から、指定された文字リストに含まれる文字をすべて削除した新しい文字列を返します。

サンプルコード

PHP mb_ltrimで文字列左端を除去する

1<?php
2
3/**
4 * PHPのmb_ltrim関数の使用例。
5 *
6 * mb_ltrimは、マルチバイト文字を考慮して、文字列の左側から指定された文字(または空白文字)を除去します。
7 * システムエンジニアを目指す初心者の方にも理解しやすいよう、基本的な使い方をいくつか示します。
8 *
9 * 注意: mb_ltrimを使用する前に、通常はmb_internal_encoding()で適切な文字エンコーディングを設定することを推奨します。
10 * これにより、マルチバイト文字列が正しく処理されるようになります。
11 */
12
13// PHPの内部文字エンコーディングをUTF-8に設定します。
14// これにより、mb_*系の関数が日本語などのマルチバイト文字を正しく扱えるようになります。
15mb_internal_encoding("UTF-8");
16
17// -----------------------------------------------------------------------------
18// 1. 文字列の左端からデフォルトの空白文字(スペース、タブ、改行など)を除去
19//    mb_ltrimの第2引数(除去する文字)を省略した場合の動作です。
20// -----------------------------------------------------------------------------
21$originalString1 = "  \t\n  Hello PHP World!  ";
22$trimmedString1 = mb_ltrim($originalString1);
23
24echo "--- 例 1: デフォルトの空白文字除去 ---\n";
25echo "元: '" . $originalString1 . "'\n";
26echo "後: '" . $trimmedString1 . "'\n";
27echo "----------------------------------------\n\n";
28
29
30// -----------------------------------------------------------------------------
31// 2. 文字列の左端から特定の文字を除去
32//    第2引数に除去したい文字を文字列として指定します。
33// -----------------------------------------------------------------------------
34$originalString2 = "###PHPは素晴らしい言語です";
35$trimmedString2 = mb_ltrim($originalString2, '#');
36
37echo "--- 例 2: 特定の文字 '#' の除去 ---\n";
38echo "元: '" . $originalString2 . "'\n";
39echo "後: '" . $trimmedString2 . "'\n";
40echo "----------------------------------------\n\n";
41
42
43// -----------------------------------------------------------------------------
44// 3. 文字列の左端から複数の種類の文字を除去
45//    第2引数に除去したい文字をすべて含んだ文字列として指定します。
46//    指定した文字のいずれかが文字列の先頭にあれば除去されます。
47// -----------------------------------------------------------------------------
48$originalString3 = "---*** PHP開発ガイド ***---";
49$trimmedString3 = mb_ltrim($originalString3, '-*'); // '-'または'*'が先頭にあれば除去
50
51echo "--- 例 3: 複数の文字 '-*' の除去 ---\n";
52echo "元: '" . $originalString3 . "'\n";
53echo "後: '" . $trimmedString3 . "'\n";
54echo "----------------------------------------\n\n";
55
56
57// -----------------------------------------------------------------------------
58// 4. マルチバイト文字(日本語)を考慮した除去
59//    mb_ltrimはマルチバイト対応なので、日本語などの文字も正しく除去できます。
60// -----------------------------------------------------------------------------
61$originalString4 = "ああああPHPを学ぼう!";
62$trimmedString4 = mb_ltrim($originalString4, 'あ');
63
64echo "--- 例 4: マルチバイト文字 'あ' の除去 ---\n";
65echo "元: '" . $originalString4 . "'\n";
66echo "後: '" . $trimmedString4 . "'\n";
67echo "----------------------------------------\n\n";
68
69
70// -----------------------------------------------------------------------------
71// 5. エンコーディングを明示的に指定して除去
72//    通常はmb_internal_encoding()で設定されたエンコーディングが使用されますが、
73//    特定の文字列が異なるエンコーディングである場合に、第3引数で明示的に指定できます。
74// -----------------------------------------------------------------------------
75$originalString5 = "  こんにちはPHP"; // 全角スペースで始まる文字列
76// この例では、文字列がUTF-8であると仮定して、全角スペースと半角スペース、タブを除去します。
77// 全角スペースは通常の空白文字とは異なるため、明示的に指定する必要があります。
78$trimmedString5 = mb_ltrim($originalString5, " \t ", "UTF-8");
79
80echo "--- 例 5: エンコーディングと全角スペースの除去 ---\n";
81echo "元: '" . $originalString5 . "'\n";
82echo "後: '" . $trimmedString5 . "'\n";
83echo "----------------------------------------\n\n";
84
85?>

PHPのmb_ltrim関数は、与えられた文字列の左端から、指定された文字や空白文字を取り除くための機能を提供します。この関数は、日本語のようなマルチバイト文字を正しく処理できる点が特徴です。

第一引数には、加工したい元の文字列を指定します。第二引数には、左端から除去したい文字を文字列として指定します。この引数を省略した場合、半角スペース、タブ、改行などのデフォルトの空白文字が自動的に除去されます。複数の文字(例: -*)を指定すると、指定した文字のいずれかが文字列の先頭にある限り連続して除去されます。

mb_ltrimはマルチバイト対応のため、「あ」のような日本語の文字や全角スペースも正確に認識し、適切に除去できます。第三引数では、処理対象の文字列の文字エンコーディングを明示的に指定できますが、通常はmb_internal_encoding()関数で設定されたPHPの内部エンコーディングが使用されます。

この関数の戻り値は、左端の不要な文字が除去された新しい文字列です。マルチバイト文字を扱うシステムでは、文字列の不要な空白や特定の記号を整形する際に非常に役立ちます。利用する前には、mb_internal_encoding()関数で適切な文字エンコーディングを設定しておくことをお勧めします。

mb_ltrim関数はPHP 8でマルチバイト文字の左端を除去する際に使用されます。この関数を安全かつ正しく利用するためには、まずプログラムの最初にmb_internal_encoding()で適切な文字エンコーディング(例:UTF-8)を設定することが非常に重要です。これにより、日本語などの全角文字も正確に処理されます。

第二引数を省略すると半角スペースやタブ、改行といったデフォルトの空白文字が除去されますが、特定の文字を除去したい場合は、それらの文字を文字列として第二引数に指定してください。複数の文字を指定することで、指定した文字のいずれかが文字列の先頭にあれば除去されます。全角スペースなどの特定のマルチバイト文字を除去する際も同様に明示的に指定する必要があります。第三引数でエンコーディングを明示的に指定することも可能ですが、通常はmb_internal_encoding()の設定に従います。

PHP mb_ltrim で文字列左端をトリムする

1<?php
2
3/**
4 * mb_ltrim 関数の基本的な使用例を示す関数。
5 * マルチバイト文字を含む文字列の左端から指定した文字を削除します。
6 * システムエンジニアを目指す初心者向けに、簡潔で分かりやすいコードを提供します。
7 */
8function demonstrateMbLtrim(): void
9{
10    // 例1: 全角スペースを含む文字列の左端をトリムする基本的な使い方
11    // mb_ltrim はデフォルトで一般的な空白文字(半角スペース、タブ、改行、全角スペースなど)を削除します。
12    // マルチバイト文字を文字として正しく認識し、処理できるのが mb_ltrim の特徴です。
13    $stringWithFullWidthSpace = "  こんにちは、PHPの世界へ!";
14    $trimmedString1 = mb_ltrim($stringWithFullWidthSpace);
15    echo "元の文字列(全角スペースあり): '{$stringWithFullWidthSpace}'\n";
16    echo "トリム後(デフォルト): '{$trimmedString1}'\n\n";
17
18    // 例2: 特定のマルチバイト文字(ここでは「。、」)を左端からトリムする
19    // 第2引数 $characters に削除したい文字のセットを指定します。
20    $stringWithSpecificChars = "。。。、こんにちは、PHP!";
21    $charactersToTrim = "。、"; // トリムしたいマルチバイト文字を指定
22    $trimmedString2 = mb_ltrim($stringWithSpecificChars, $charactersToTrim);
23    echo "元の文字列(特定の文字あり): '{$stringWithSpecificChars}'\n";
24    echo "トリム後(指定文字「{$charactersToTrim}」): '{$trimmedString2}'\n\n";
25
26    // 例3: 半角スペースと特定のマルチバイト文字(例: ★)を組み合わせて左端からトリムする
27    // $characters に複数の種類の文字を混ぜて指定することも可能です。
28    $stringWithMixedChars = "  ★★★PHP学習中!";
29    $mixedCharactersToTrim = " ★"; // 半角スペースとマルチバイト文字を組み合わせる
30    $trimmedString3 = mb_ltrim($stringWithMixedChars, $mixedCharactersToTrim);
31    echo "元の文字列(半角スペースと★あり): '{$stringWithMixedChars}'\n";
32    echo "トリム後(指定文字「{$mixedCharactersToTrim}」): '{$trimmedString3}'\n\n";
33}
34
35// mb_ltrim 関数のデモンストレーションを実行します。
36demonstrateMbLtrim();
37

PHP 8で提供されるmb_ltrim関数は、マルチバイト文字を含む文字列の左端から、指定された文字を取り除くために使用されます。通常のltrim関数では、日本語などのマルチバイト文字を正しく扱えない場合があるため、これらの文字を含む文字列の整形にはmb_ltrimの使用が推奨されます。

この関数は主に3つの引数を取ります。最初の引数$stringには、処理対象となる元の文字列を指定します。2番目の引数$charactersは、文字列の左端から削除したい文字のセットを指定します。この引数を省略した場合、mb_ltrimは半角スペース、タブ、改行、全角スペースなど、一般的な空白文字を自動的に削除します。3番目の引数$encodingは文字エンコーディングを指定しますが、通常はデフォルト設定で問題ありません。関数は、指定された文字が左端から全て削除された新しい文字列を戻り値として返します。

サンプルコードでは、mb_ltrimの具体的な使用方法を示しています。まず、全角スペースを含む文字列から、デフォルトの空白文字を削除する基本的な例を紹介しています。次に、「。、」のような特定のマルチバイト文字を$characters引数に指定することで、これらの文字を左端から効率的に取り除く方法を示しています。さらに、半角スペースと「★」のような特定のマルチバイト文字を組み合わせて、両方を一度に削除する応用例も確認できます。mb_ltrimは、ユーザーからの入力データの整形やシステム内部でのデータクリーニングなど、文字列の整合性を保つための様々な場面で役立ちます。

mb_ltrim関数は、マルチバイト文字(日本語や全角スペースなど)を含む文字列の左端を正確にトリムするために利用します。通常のltrim関数ではマルチバイト文字を正しく扱えないため、全角文字を削除したい場合は本関数を選んでください。

この関数はPHPのmbstring拡張モジュールが有効である必要があります。もし動作しない場合は、PHPの設定を確認してください。第2引数$charactersを省略した場合、半角・全角スペースやタブ、改行コードなど、PHPが定義する一般的な空白文字を削除します。

特に、第3引数$encodingの指定は重要です。これを省略するとPHPの内部エンコーディングが使用されますが、意図しない結果や文字化けを防ぐため、処理する文字列のエンコーディングを明示的に指定することをお勧めします。これにより、異なる環境での動作の一貫性が保たれます。

関連コンテンツ

関連プログラミング言語