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

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

作成日: 2025年09月11日更新日: 2025年09月29日

基本的な使い方

mb_scrub関数は、文字列から不正なバイトシーケンスを削除または置換する関数です。この関数は、マルチバイト文字列を扱う際に、予期せぬ文字エンコーディングの問題や、文字化け、セキュリティ上のリスクを引き起こす可能性のある無効なバイト列を取り除くために使用されます。

具体的には、mb_scrub関数は指定された文字列をスキャンし、現在の文字エンコーディング（または指定されたエンコーディング）において不正なバイトシーケンスを検出します。検出された不正なバイトシーケンスは、デフォルトでは空文字列に置換されます。しかし、オプションの引数を使用することで、別の文字列（例えば、疑問符"?"など）に置換することも可能です。

この関数は、特に外部ソースから取得した文字列や、文字エンコーディングが不明確な文字列を処理する際に有用です。例えば、データベースからのデータ、ユーザーからの入力、ファイルからの読み込みなどが挙げられます。これらの文字列をそのまま処理する前にmb_scrub関数を適用することで、アプリケーションの安定性とセキュリティを向上させることができます。

文字エンコーディングを指定しない場合、mb_internal_encoding()で設定された内部文字エンコーディングが使用されます。エンコーディングを明示的に指定することで、より正確な不正バイトシーケンスの検出と置換が可能になります。

mb_scrub関数は、文字列を安全に扱うための重要なツールであり、システムエンジニアが文字エンコーディングに関する問題を解決する上で役立ちます。不正なバイトシーケンスによる潜在的な問題を未然に防ぎ、アプリケーションの信頼性を高めるために、積極的に活用することを推奨します。

構文(syntax)


1mb_scrub(string $string, string $encoding = null): string

引数(parameters)

string $string, ?string $encoding = null

string $string: 処理対象の文字列を指定します。
?string $encoding = null: 文字エンコーディングを指定します。省略すると、内部エンコーディングが使用されます。

戻り値(return)

string

指定された文字列から、許可されていない文字を削除した新しい文字列を返します。

サンプルコード

mb_scrubで不正バイトを置換する


1<?php
2
3/**
4 * mb_scrub 関数の使用例を示します。
5 * この関数は、指定された文字列内の不正なバイトシーケンス（無効なマルチバイト文字やエンコーディングエラーなど）を検出し、
6 * 代替文字（通常は '�' - U+FFFD REPLACEMENT CHARACTER）に置き換えて文字列をクリーンアップします。
7 * 異なるエンコーディング間でデータを処理する場合や、外部からの不正な入力データを扱う際に特に役立ちます。
8 */
9function demonstrateMbScrubExample(): void
10{
11    // 不正なバイトシーケンスを含むUTF-8文字列の例。
12    // \xe4\xba は不完全なUTF-8文字の開始、\x80 はUTF-8で不正な単独バイトです。
13    $invalidUtf8String = "こんにちは\xe4\xba\xed世界\x80です";
14
15    echo "元の文字列: " . $invalidUtf8String . PHP_EOL;
16    // バイト列を表示することで、不正なシーケンスがどのように含まれているか確認できます。
17    echo "  (バイト列: " . bin2hex($invalidUtf8String) . ")" . PHP_EOL;
18
19    // mb_scrub を使用して文字列をクリーンアップします。
20    // 第2引数を省略すると、mb_internal_encoding() で設定されている現在の内部エンコーディング
21    // (通常は 'UTF-8') が使用されます。
22    $cleanedString = mb_scrub($invalidUtf8String);
23
24    echo "mb_scrub 適用後: " . $cleanedString . PHP_EOL;
25    // 不正なバイトシーケンスが代替文字 ('�'、UTF-8では \xef\xbf\xbd) に置き換えられていることが確認できます。
26    echo "  (バイト列: " . bin2hex($cleanedString) . ")" . PHP_EOL;
27}
28
29// サンプル関数を実行します。
30demonstrateMbScrubExample();
31

mb_scrub関数は、指定された文字列内に含まれる不正なバイトシーケンス（無効なマルチバイト文字やエンコーディングエラーなど）を検出し、代替文字（通常は「�」）に置き換えて文字列をクリーンアップするためのPHP関数です。これにより、文字化けや処理エラーの原因となる問題を解消します。

この関数は、最初の引数$stringに処理対象の文字列を受け取ります。2番目の引数$encodingはオプションで、文字列のエンコーディングを指定します。この引数を省略した場合、PHPの内部エンコーディング設定（多くの場合UTF-8）が使用されます。処理後には、クリーンアップされた新しい文字列がstring型で返されます。

サンプルコードでは、意図的に不完全なUTF-8バイトシーケンスを含む文字列を定義し、その文字列をmb_scrub関数で処理しています。処理前には不正なバイトが含まれていることがバイト列で確認できますが、mb_scrubを適用すると、これらの不正な部分が代替文字「�」に置き換えられ、有効な文字列に変換されていることが示されています。

この関数は、外部からの不正な入力データを取り扱う場合や、異なるエンコーディング間でデータを処理する際に、データの整合性を保ち、プログラムの安定性を向上させるために特に有用です。

mb_scrub関数は、不正なバイトシーケンスを代替文字（通常 '�'）に置き換えることで文字列をクリーンアップしますが、これにより元の情報の一部が失われる点に注意が必要です。特に、入力される文字列のエンコーディングが不明確な場合、第2引数で適切なエンコーディングを明示的に指定することをお勧めします。これを省略すると、現在の内部エンコーディングが適用され、意図しない結果を招く可能性があります。この関数はPHP 8で追加されたため、それ以前のPHPバージョンでは動作しません。外部からの入力データを扱う際に非常に有用ですが、データ入力から出力までの全体的なエンコーディング管理と併せて利用することが、安全なシステム構築につながります。

PHP mb_scrubで不正バイトをクリーンアップする


1<?php
2
3declare(strict_types=1);
4
5// mb_scrub は、指定された文字列内の不正なバイトシーケンスを検出し、
6// 指定されたエンコーディング規則に従ってそれらをクリーンアップ（削除または置換）します。
7// これは、外部からの入力や異なるエンコーディング間の変換で発生しうる
8// 不正な文字を処理する際に役立ちます。
9
10// 例: 不正なUTF-8バイトシーケンスを含む文字列を作成します。
11// '\xed\xa0\x80' は単独では不正なUTF-8シーケンスの一例です（サロゲート文字範囲）。
12// '\xF0\x9F\x8E\x89' は有効なUTF-8絵文字（🎉）です。
13$originalString = "Hello" . "\xed\xa0\x80" . "World!" . "\xF0\x9F\x8E\x89";
14
15echo "--- mb_scrub 関数による不正なバイトシーケンスのクリーンアップ ---" . PHP_EOL;
16
17// 元の文字列の内容とバイト列を表示します。
18echo "元の文字列 (表示): " . $originalString . PHP_EOL;
19echo "元の文字列 (バイト列): " . bin2hex($originalString) . PHP_EOL . PHP_EOL;
20
21// mb_scrub を使用して、不正なUTF-8バイトシーケンスをクリーンアップします。
22// 第二引数に 'UTF-8' を指定することで、UTF-8として文字列を検証しクリーンアップします。
23// 不正なシーケンスは、通常は置換文字（U+FFFD �）または空文字に置換されます。
24$scrubbedString = mb_scrub($originalString, 'UTF-8');
25
26// クリーンアップ後の文字列の内容とバイト列を表示します。
27echo "クリーンアップ後の文字列 (表示): " . $scrubbedString . PHP_EOL;
28echo "クリーンアップ後の文字列 (バイト列): " . bin2hex($scrubbedString) . PHP_EOL;
29
30?>

mb_scrub関数は、指定された文字列の中に含まれる「不正なバイトシーケンス」を検出し、指定された文字エンコーディング規則に基づいてこれらをクリーンアップするために使用されます。不正なバイトシーケンスとは、特定の文字エンコーディングのルールに則っていない文字の並びのことで、文字化けやシステムのエラーの原因となることがあります。

この関数は、主に外部からの入力データや、異なるエンコーディング形式のデータを扱う際に、予期せぬ文字が含まれている場合にその問題を解決するために役立ちます。

引数$stringには、クリーンアップの対象となる元の文字列を指定します。引数$encodingには、その文字列がどの文字エンコーディング（例えば'UTF-8'）であるかを指定します。この指定に従って、関数は文字列内のバイトシーケンスが正しいかどうかを検証し、不正な部分を処理します。$encodingを省略した場合、PHPの内部エンコーディングが使用されます。

戻り値としては、不正なバイトシーケンスが除去されるか、または安全な代替文字（通常は「�」（U+FFFD: REPLACEMENT CHARACTER）のような記号）に置換された新しい文字列が返されます。元の文字列自体は変更されません。

提供されたサンプルコードでは、意図的に不正なUTF-8バイトシーケンス（\xed\xa0\x80）を含む文字列を作成しています。mb_scrub関数を呼び出し、エンコーディングとして'UTF-8'を指定することで、この不正なシーケンスが検出され、クリーンアップ後の文字列では安全な置換文字に変換されていることが確認できます。このようにmb_scrubを使用することで、プログラムが不正な文字データによって誤動作するのを防ぎ、堅牢なデータ処理を実現できます。

mb_scrub関数は、入力文字列内の不正なバイトシーケンスを指定されたエンコーディング規則に基づいてクリーンアップします。最も重要な注意点は、第二引数に処理対象となる文字列の正確なエンコーディングを指定することです。誤ったエンコーディングを指定すると、有効な文字が不正と判断されたり、逆に不正なシーケンスが検出されずに残ってしまう可能性があります。

この関数は、不正なバイトシーケンスを通常は置換文字（U+FFFD �）や空文字に置き換えるため、元の文字列の内容が変更される点を必ず認識してください。元のデータの一部が失われたり、置き換わったりすることを考慮し、その後のプログラムの動作に影響がないか確認することが必要です。

主に、外部からの入力データや異なるシステム間のデータ連携において、文字化けやセキュリティ上の問題を引き起こす可能性のある不正な文字を安全に処理するために利用されます。利用する際は、入力文字列のエンコーディングを事前に確実に把握し、適切に指定することが安全かつ正しく機能させるための鍵となります。