xml_set_processing_instruction_handler

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

xml_set_processing_instruction_handler — 処理命令 (PI) 用ハンドラを設定する

説明

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

XML パーサ parserの処理命令 (PI) 用ハンドラ関数を設定します。

処理命令は、次のフォーマットを有しています。

<?

target data

?>

このようなタグに PHP コードを入れることが可能ですが、一つの制約に注意してください。XML PI において、PI 終了タグ (?>)は引用符で括ることができません。このため、この文字の並びを XML ドキュメント中にPIにより埋め込んだ PHP コードの中で使用することはできません。これを使用した場合、残りの PHP コードは、"真の" PI 終了タグと同じく文字データとして処理されます。

パラメータ

parser

処理命令 (PI) ハンドラ関数を設定する XML パーサへの参照。

handler

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

handler という名前の関数は、次の 3 つのパラメータを引数とする必要があります。

handler(XMLParser $parser, string $target, string $data)

parser: 最初のパラメータ、parser はハンドラをコールする XML パーサへのリファレンスです。
target: 第 2 のパラメータ、target は PI のターゲットを有しています。
data: 第 3 のパラメータ、data は、 PI のデータを有しています。

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

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

戻り値

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

変更履歴

バージョン	説明
8.0.0	引数 `parser` は、 XMLParser インスタンスを期待するようになりました。これより前のバージョンでは、リソースが期待されていました。

関連キーワード: 　ハンドラ, 処理, 設定, 命令, handler, parser, 関数, パラメータ, パーサ, data