PHP – mb_substitute_character()関数で置換文字を取得・設定する方法

PHPでは、mb_substitute_character()関数を使用することで、置換文字の取得や設定を行うことができます。この関数は、入力文字エンコーディングが不正な場合や、出力文字エンコーディングに存在しない文字コードが含まれている際に、代わりに使用される置換文字を指定するものです。

注意： 不正な文字は、何も出力されない状態、string型の文字列、またはint値（Unicode文字コード値）のいずれかで置き換えられる可能性があります。

構文

string mb_substitute_character($char)

パラメータ

この関数が受け取るパラメータは、$char の1つだけです。

• $char − 整数でUnicode値を指定するか、または以下のいずれかの文字列を指定します。

  • "none" − 何も出力しません。

  • "long" − 文字コード値を出力する際に使用します。例：「U+3000、JIS+7E7E」

  • "entity" − 文字エンティティを出力する際に使用します。例：「&#x200」。

戻り値

mb_substitute_character の設定を行った場合は、成功時にTrueを返し、失敗時にはFalseを返します。設定が行われていない場合は、現在の設定値を返します。

注意： PHP 8.0では、substitute_character に空文字列を渡すことはサポートされていません。

サンプルコード

<?php
    // Unicode U+3013 を設定します
    mb_substitute_character(0x3013);

    // 16進形式を指定します
    mb_substitute_character("long");

    // 現在の設定を表示します
    echo mb_substitute_character();
?>

実行結果

long