xml_set_character_data_handler

(PHP 4, PHP 5, PHP 7, PHP 8)

xml_set_character_data_handler文字データハンドラを設定する

説明

xml_set_character_data_handler(XMLParser $parser, callable $handler): bool

XML パーサ parser の文字データ用ハンドラ関数を設定します。

パラメータ

parser

文字データハンドラ関数を設定する XML パーサへの参照。

handler

handler は、parser に関して xml_parse() がコールされた際に必要な関数の名前を有する文字列です。

handler という名前の関数は、次の 2 つのパラメータをとります。

handler(XMLParser $parser, string $data)
parser
最初のパラメータである parser は、 ハンドラをコールする XML パーサへのリファレンスです。
data
2番目のパラメータである data は、 文字データを文字列として有しています。

文字データハンドラは、XML ドキュメントのすべてのテキストに対してコールされます。 (たとえば非 ASCII 文字列などで) ひとつのフラグメント内で複数回コールされることもあります。

ハンドラ関数が空の文字列または、 false に設定されている場合、そのハンドラは無効です。

注意: 関数名の代わりに、オブジェクトへの リファレンスを格納した配列とメソッド名を指定することもできます。

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン 説明
8.0.0 引数 parser は、 XMLParser インスタンスを期待するようになりました。 これより前のバージョンでは、リソースが期待されていました。
関連キーワード:  ハンドラ, 文字, データ, 設定, parser, handler, 関数, data, パーサ, パラメータ