xml_set_processing_instruction_handler

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

説明

true xml_set_processing_instruction_handler(XMLParser $parser, callable $handler)

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

処理命令のフォーマットは以下のとおりです:

<?target
data
?>

警告

PHP コードは、処理命令 <?php によって区切られます。 よって、XMLドキュメントに PHP コードを入れることが可能です。 しかし、PI 終了タグ (?>) をデータに含めてはいけません。 PI 終了タグ が埋め込まれたPHPコードの一部として存在していた場合、 残りの PHP コードは、"真の" PI 終了タグと同じく文字データとして処理されます。

パラメータ

parser

XMLパーサ

handler

null が渡されると、ハンドラはデフォルトの状態にリセットされます。

警告

空文字列を渡すことでもハンドラはリセットされますが、これは PHP 8.4.0 以降非推奨となっています。

handlercallable の場合、その callable がハンドラとして設定されます。

handler が文字列の場合、xml_set_object で設定されたオブジェクトのメソッド名になります。

警告

PHP 8.4.0 以降、非推奨となっています。

警告

PHP 8.4.0 以降では、実際に呼び出されるときではなく、ハンドラを設定する際に callable であるかがチェックされます。 従って、コールバックとしてメソッド文字列を指定する場合、それより前に、 xml_set_object を呼び出しておく必要があります。 しかし、この動作も PHP 8.4.0 以降非推奨となっているため、メソッドには適切な callable を使用することが推奨されます。

handler のシグネチャは、下記でなければいけません:

void handler(XMLParser $parser, string $target, string $data)
parser
ハンドラをコールするXMLパーサ
target
処理命令のターゲット
data
処理命令のデータ

戻り値

常に true を返します。

変更履歴

バージョン 説明
8.4.0 callablestringhandler に渡すことは、現在非推奨となっています。 メソッドには適切な callable を使用するか、ハンドラをリセットする場合は null を使用してください。
8.4.0 handlercallable として有効であるかどうかは、 呼び出し時ではなく、ハンドラーを設定する際にチェックされるようになりました。
8.0.0 引数 parser は、 XMLParser インスタンスを期待するようになりました。 これより前のバージョンでは、有効な xml resource が期待されていました。