【PHP8.x】xml_parser_get_option関数の使い方

作成日: 2025年09月11日更新日: 2025年10月07日

xml_parser_get_option関数は、指定されたXMLパーサの特定のオプション設定を取得する関数です。PHPのXML処理拡張機能において、XMLデータを解析する際のパーサの挙動は様々なオプションによって細かく制御されます。この関数は、現在どのようなオプションが有効になっているか、またはその値がどう設定されているかを確認するために利用されます。

この関数を使用する際は、まずxml_parser_create()関数などを用いて作成されたXMLパーサのインスタンス（PHP 8以降ではXMLParserオブジェクト）を最初の引数として渡します。二番目の引数には、取得したいオプションの種類を示す定数を指定します。例えば、XML_OPTION_TARGET_ENCODINGは出力エンコーディング、XML_OPTION_SOURCE_ENCODINGは入力エンコーディング、XML_OPTION_EXTERNAL_ENTITY_PARSINGは外部エンティティの処理に関する設定を表します。他にも、テキストのみを持つタグをスキップするかどうかを設定するXML_OPTION_SKIP_TAG_WITH_TEXTや、空白文字をスキップするかどうかを設定するXML_OPTION_SKIP_WHITEといったオプションがあります。

関数が正常に実行されると、指定されたオプションの現在の値が返されます。例えば、エンコーディング関連のオプションであればエンコーディング名（例: "UTF-8"）が文字列として返され、ブール値のオプションであれば0または1（それぞれfalseまたはtrueを意味します）が整数として返されます。もしオプションの取得に失敗した場合はfalseが返されます。XMLデータの解析設定をデバッグしたり、実行時にパーサの現在の状態を確認したりする際に、この関数は重要な役割を果たします。

基本的な使い方

構文(syntax)

<?php
$parser = xml_parser_create();
// XML_OPTION_CASE_FOLDING オプションの値を取得
$optionValue = xml_parser_get_option($parser, XML_OPTION_CASE_FOLDING);
xml_parser_free($parser);
?>

引数(parameters)

XMLParser $parser, int $option

XMLParser $parser: オプションを取得したい XML パーサーリソースを指定します。
int $option: 取得したいオプションの種類を指定します。PHP に定義されている XML パーサーオプション定数（例: XML_OPTION_CASE_FOLDING）を使用します。

戻り値(return)

string|int|false

xml_parser_get_option 関数は、指定された XML パーサーオプションの値を取得します。取得した値は、オプションの種類に応じて文字列 (string) または整数 (int) として返されます。オプションの取得に失敗した場合は false を返します。